SCSS-Lint 项目使用教程

1. 项目目录结构及介绍

SCSS-Lint 是一个用于保持 SCSS 文件清洁和可读的工具，它通过一系列可配置的语法检查规则来运行。项目目录结构如下：

• bin/: 包含可执行脚本。
• config/: 存储配置文件。
• data/: 包含默认的规则列表和其他相关数据。
• lib/: 包含 SCSS-Lint 的 Ruby 库代码。
• logo/: 存储项目标志。
• spec/: 包含项目的单元测试代码。
• .editorconfig: 用于定义编辑器配置的文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .mailmap: 用于规范 Git 提交记录中的作者信息的文件。
• .overcommit.yml: 配置 Overcommit 钩子的文件。
• .projections.json: 包含项目配置信息的文件。
• .rspec: RSpec 配置文件。
• .rubocop.yml: RuboCop 配置文件。
• .rubocop_todo.yml: RuboCop 待办事项配置文件。
• .simplecov: SimpleCov 覆盖率报告配置文件。
• CHANGELOG.md: 记录项目更新历史的文件。
• Gemfile: Ruby 项目的依赖文件。
• MIT-LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• Rakefile: Rake 任务配置文件。
• scss_lint.gemspec: SCSS-Lint 的 Gem 规范文件。

2. 项目的启动文件介绍

SCSS-Lint 项目没有传统意义上的启动文件，因为它是一个命令行工具。使用 Gemfile 文件来定义项目依赖，并通过运行 bundle install 来安装这些依赖。一旦依赖安装完成，可以通过命令行直接使用 scss-lint 命令。

3. 项目的配置文件介绍

SCSS-Lint 使用 .scss-lint.yml 文件来进行配置。这个文件可以放在项目的根目录或者用户的家目录下。配置文件的格式如下：

scss_files:
  - 'app/assets/stylesheets/**/*.css.scss'

exclude:
  - 'app/assets/stylesheets/plugins/**'

linters:
  BorderZero:
    enabled: false
  Indentation:
    exclude:
      - 'path/to/file.scss'
      - 'path/to/directory/**'
    severity: warning
    width: 2

在配置文件中，可以指定要检查的 SCSS 文件路径，排除不需要检查的文件或目录，以及配置各个检查器的选项。每个检查器都可以通过 enabled 选项来启用或禁用，并且可以设置特定的选项，如 severity 来指定警告或错误，width 来设置缩进宽度等。配置文件的详细说明可以在项目的官方文档中找到。