mirror of
https://github.com/discourse/discourse.git
synced 2024-11-26 14:03:39 +08:00
bdaaac9c9f
## How does this work? Any time a lint rule is added or changed, you can run `yarn lint:fix` to handle all the auto-fixable situations. But not all lints are auto-fixable -- for those, lint-to-the-future has tooling to automatically ignore present violations. An alias has been added for lint-to-the-future to ignore new violations, `yarn lttf:ignore`. The command will add lint-ignore declarations throughout all the files with present violations, which should then be committed. An excerpt from lint-to-the-future's [README](https://github.com/mansona/lint-to-the-future#lint-to-the-future-dashboard): > The point of Lint to the Future is to allow you to progressively update your codebase using new lint rules without overwhelming you with the task. You can easily ignore lint rules using project-based ignores in your config files but that doesn't prevent you from making the same errors in new files. > We chose to do the ignores on a file basis as it is a perfect balance and it means that the tracking/graphing aspects of Lint to the Future provide you with achievable goals, especially in large codebases. ## How do I view progress? lint-to-the-future provides graphs of violations-over-time per lint rule in a dashboard format, so we can track how well we're doing at cleaning up the violations. To view the dashboard locally, run `yarn lint-progress` and visit `http://localhost:8084` (or whatever the port it chose, as it will choose a new port if 8084 is preoccupied) Also there is a `list` command which shows a JSON object of: ```ts { [date: string]: { // yyyy-mm-dd [pluginName: string]: { [fileName: string]: string[]; // list of files with violations } } } ``` ```bash yarn lint-to-the-future list --stdout ``` ## What about lint-todo? Lint todo is another system available for both eslint and ember-template-lint that _forces_ folks to "leave things better than they found them" by being transparent / line-specific ignoring of violations. It was decided that for _this_ project, it made more sense, and would be less disruptive to new contributors to have the ignore declarations explicitly defined in each file (whereas in lint-todo, they are hidden). To effectively use lint-todo, a whole team needs to agree to the workflow, and in open source, we want "just anyway" to be able to contribute, and throwing surprises at them can deter contributions.
105 lines
2.8 KiB
YAML
105 lines
2.8 KiB
YAML
name: Linting
|
|
|
|
on:
|
|
pull_request:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
concurrency:
|
|
group: linting-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build:
|
|
if: "!(github.event_name == 'push' && github.repository == 'discourse/discourse-private-mirror')"
|
|
name: run
|
|
runs-on: ubuntu-latest
|
|
container: discourse/discourse_test:slim
|
|
timeout-minutes: 30
|
|
|
|
steps:
|
|
- name: Set working directory owner
|
|
run: chown root:root .
|
|
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 1
|
|
|
|
- name: Setup Git
|
|
run: |
|
|
git config --global user.email "ci@ci.invalid"
|
|
git config --global user.name "Discourse CI"
|
|
|
|
- name: Bundler cache
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: vendor/bundle
|
|
key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-gem-
|
|
|
|
- name: Setup gems
|
|
run: |
|
|
gem install bundler --conservative -v $(awk '/BUNDLED WITH/ { getline; gsub(/ /,""); print $0 }' Gemfile.lock)
|
|
bundle config --local path vendor/bundle
|
|
bundle config --local deployment true
|
|
bundle config --local without development
|
|
bundle install --jobs 4
|
|
bundle clean
|
|
|
|
- name: Get yarn cache directory
|
|
id: yarn-cache-dir
|
|
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
|
|
|
|
- name: Yarn cache
|
|
uses: actions/cache@v3
|
|
id: yarn-cache
|
|
with:
|
|
path: ${{ steps.yarn-cache-dir.outputs.dir }}
|
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-yarn-
|
|
|
|
- name: Yarn install
|
|
run: yarn install
|
|
|
|
- name: Rubocop
|
|
if: ${{ !cancelled() }}
|
|
run: bundle exec rubocop --parallel .
|
|
|
|
- name: syntax_tree
|
|
if: ${{ !cancelled() }}
|
|
run: |
|
|
set -E
|
|
bundle exec stree check Gemfile $(git ls-files '*.rb') $(git ls-files '*.rake')
|
|
|
|
- name: ESLint (core)
|
|
if: ${{ !cancelled() }}
|
|
run: yarn lint:js
|
|
|
|
- name: ESLint (core plugins)
|
|
if: ${{ !cancelled() }}
|
|
run: yarn lint:js-plugins
|
|
|
|
- name: Prettier
|
|
if: ${{ !cancelled() }}
|
|
run: |
|
|
yarn prettier -v
|
|
yarn lint:prettier
|
|
|
|
- name: Ember template lint
|
|
if: ${{ !cancelled() }}
|
|
run: yarn lint:hbs
|
|
|
|
- name: English locale lint (core)
|
|
if: ${{ !cancelled() }}
|
|
run: bundle exec ruby script/i18n_lint.rb "config/**/locales/{client,server}.en.yml"
|
|
|
|
- name: English locale lint (core plugins)
|
|
if: ${{ !cancelled() }}
|
|
run: bundle exec ruby script/i18n_lint.rb "plugins/**/locales/{client,server}.en.yml"
|