Feb 27, 2021 · Feb 27, 2021 · Feb 27, 2021 · Feb 27, 2021 · Feb 27, 2021 · Feb 28, 2021
diff --git a/.cspell.json b/.cspell.json
  "version": "0.1",
  "language": "en",
  "ignorePaths": [
    "**/coverage/**",
    "**/node_modules/**",
    "**/dist/**",
    "**/fixtures/**",
    ".cspell.json",
    ".github/workflows/**",
    ".vscode/*.json",
    "**/*.{json,snap}",
    "**/**/CHANGELOG.md",
    "**/**/CONTRIBUTORS.md",
    "**/**/ROADMAP.md",
    "**/*.{json,snap}",
    ".cspell.json",
    "yarn.lock",
    ".github/workflows/**",
    ".vscode/*.json"
    "**/coverage/**",
    "**/dist/**",
    "**/fixtures/**",
    "**/node_modules/**",
    "packages/website/.docusaurus/**",
    "packages/website/build/**",
    "yarn.lock"
  ],
  "dictionaries": [
    "typescript",
  ],
  "overrides": [
    {
      "filename": "**/*.{ts,js}",
      "filename": "**/*.{ts,js,tsx,jsx}",
      "ignoreRegExpList": ["/@[a-z]+/", "/#(end)?region/"],
      "includeRegExpList": [
        "/\\/\\*[\\s\\S]*?\\*\\/|([^\\\\:]|^)\\/\\/.*$/",
diff --git a/.eslintignore b/.eslintignore

 packages/eslint-plugin-tslint/tests

 packages/website/**/*.js
 packages/website/**/*.d.ts

 # Files copied as part of the build
 packages/types/src/ast-spec.ts
diff --git a/.eslintrc.js b/.eslintrc.js
        'import/no-default-export': 'off',
      },
    },
    {
      files: ['packages/website/src/**/*.{ts,tsx}'],
      rules: {
        'import/no-default-export': 'off',
        'no-console': 'off',
      },
    },
  ],
 };
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml

      - name: Build
        run: |
          yarn build
          yarn build --exclude website

      # Note that this command *also* type checks tests/tools,
      # whereas the build only checks src files

      - name: Build
        run: |
          yarn build
          yarn build --exclude website

      - name: Run unit tests for typescript-estree
        run: npx nx test @typescript-eslint/typescript-estree

      - name: Build
        run: |
          yarn build
          yarn build --exclude website

      - name: Check code formatting
        run: yarn check-format

      - name: Build
        run: |
          yarn build
          yarn build --exclude website

      - name: Run integrations tests
        run: yarn test-integration

      - name: Build
        run: |
          yarn build
          yarn build --exclude website

      - name: Run unit tests for typescript-estree
        run: npx nx test @typescript-eslint/typescript-estree

      - name: Build
        run: |
          yarn build
          yarn build --exclude website

      - name: Publish all packages to npm
        run: npx lerna publish --loglevel=verbose --canary --exact --force-publish --yes
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

  website:
    name: Build the documentation website
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js 16
        uses: actions/setup-node@v1
        with:
          node-version: 16

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v2
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build Website
        run: |
          yarn nx run website:build
diff --git a/.gitignore b/.gitignore
 yarn-debug.log*
 yarn-error.log*

 # Website
 packages/website/.docusaurus
 packages/website/.cache-loader
 packages/website/build

 # Runtime data
 pids
 *.pid
 # next.js build output
 .next


 # Editor-specific metadata folders
 .vs

diff --git a/.prettierignore b/.prettierignore
 # Ignore CHANGELOG.md files to avoid issues with automated release job
 CHANGELOG.md

 packages/website/.docusaurus
 packages/website/build

 # TODO - remove this once prettier supports TS4.1
 packages/scope-manager/tests/fixtures/type-declaration/literal-type1.ts
 packages/scope-manager/tests/fixtures/type-declaration/literal-type2.ts
diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md
 # Getting Started
 ---
 title: Getting Started
 sidebar_label: Getting Started
 slug: /
 ---

 Approaching a monorepo project like this can be pretty daunting and hard to navigate for a new user.

 The goal of these docs are to give you a quick overview of the project and all of its the pieces, as well as provide guides to help you get setup.

 The docs are broken down into the following categories:

 ## [I want to lint my TypeScript codebase.](./linting/README.md)
 - [I want to lint my TypeScript codebase.](./linting/README.md)

 ## [(TODO) I want to write an ESLint plugin in TypeScript.](./plugin-development/README.md)
 - [(TODO) I want to write an ESLint plugin in TypeScript.](./plugin-development/README.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,18 +2,20 @@
		"version": "0.1",
		"language": "en",
		"ignorePaths": [
		"/coverage/",
		"/node_modules/",
		"/dist/",
		"/fixtures/",
		".cspell.json",
		".github/workflows/**",
		".vscode/*.json",
		"*/.{json,snap}",
		"//CHANGELOG.md",
		"//CONTRIBUTORS.md",
		"//ROADMAP.md",
		"*/.{json,snap}",
		".cspell.json",
		"yarn.lock",
		".github/workflows/**",
		".vscode/*.json"
		"/coverage/",
		"/dist/",
		"/fixtures/",
		"/node_modules/",
		"packages/website/.docusaurus/**",
		"packages/website/build/**",
		"yarn.lock"
		],
		"dictionaries": [
		"typescript",
Expand DownExpand Up		@@ -104,7 +106,7 @@
		],
		"overrides": [
		{
		"filename": "*/.{ts,js}",
		"filename": "*/.{ts,js,tsx,jsx}",
		"ignoreRegExpList": ["/@[a-z]+/", "/#(end)?region/"],
		"includeRegExpList": [
		"/\\/\\[\\s\\S]?\\\\/\|([^\\\\:]\|^)\\/\\/.$/",
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,5 +8,8 @@ __snapshots__

		packages/eslint-plugin-tslint/tests

		packages/website/*/.js
		packages/website/*/.d.ts

		# Files copied as part of the build
		packages/types/src/ast-spec.ts
Original file line number	Diff line number	Diff line change
Expand Up		@@ -304,5 +304,12 @@ module.exports = {
		'import/no-default-export': 'off',
		},
		},
		{
		files: ['packages/website/src/*/.{ts,tsx}'],
		rules: {
		'import/no-default-export': 'off',
		'no-console': 'off',
		},
		},
		],
		};
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,7 +50,7 @@ jobs:

		- name: Build
		run: \|
		yarn build
		yarn build --exclude website

		# Note that this command also type checks tests/tools,
		# whereas the build only checks src files
Expand DownExpand Up		@@ -92,7 +92,7 @@ jobs:

		- name: Build
		run: \|
		yarn build
		yarn build --exclude website

		- name: Run unit tests for typescript-estree
		run: npx nx test @typescript-eslint/typescript-estree
Expand DownExpand Up		@@ -170,7 +170,7 @@ jobs:

		- name: Build
		run: \|
		yarn build
		yarn build --exclude website

		- name: Check code formatting
		run: yarn check-format
Expand DownExpand Up		@@ -213,7 +213,7 @@ jobs:

		- name: Build
		run: \|
		yarn build
		yarn build --exclude website

		- name: Run integrations tests
		run: yarn test-integration
Expand DownExpand Up		@@ -255,7 +255,7 @@ jobs:

		- name: Build
		run: \|
		yarn build
		yarn build --exclude website

		- name: Run unit tests for typescript-estree
		run: npx nx test @typescript-eslint/typescript-estree
Expand DownExpand Up		@@ -337,9 +337,40 @@ jobs:

		- name: Build
		run: \|
		yarn build
		yarn build --exclude website

		- name: Publish all packages to npm
		run: npx lerna publish --loglevel=verbose --canary --exact --force-publish --yes
		env:
		NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

		website:
		name: Build the documentation website
		runs-on: ubuntu-latest
		steps:
		- uses: actions/checkout@v2
		- name: Use Node.js 16
		uses: actions/setup-node@v1
		with:
		node-version: 16

		- name: Get yarn cache directory path
		id: yarn-cache-dir-path
		run: echo "::set-output name=dir::$(yarn cache dir)"

		- uses: actions/cache@v2
		id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
		with:
		path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
		key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
		restore-keys: \|
		${{ runner.os }}-yarn-

		- name: Install dependencies
		run: \|
		yarn --ignore-engines --frozen-lockfile --ignore-scripts
		yarn check-clean-workspace-after-install

		- name: Build Website
		run: \|
		yarn nx run website:build
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,6 +5,11 @@ npm-debug.log*
		yarn-debug.log*
		yarn-error.log*

		# Website
		packages/website/.docusaurus
		packages/website/.cache-loader
		packages/website/build

		# Runtime data
		pids
		*.pid
Expand DownExpand Up		@@ -57,7 +62,6 @@ jspm_packages/
		# next.js build output
		.next


		# Editor-specific metadata folders
		.vs

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,6 +16,9 @@ CONTRIBUTORS.md
		# Ignore CHANGELOG.md files to avoid issues with automated release job
		CHANGELOG.md

		packages/website/.docusaurus
		packages/website/build

		# TODO - remove this once prettier supports TS4.1
		packages/scope-manager/tests/fixtures/type-declaration/literal-type1.ts
		packages/scope-manager/tests/fixtures/type-declaration/literal-type2.ts
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,11 +1,15 @@
		# Getting Started
		---
		title: Getting Started
		sidebar_label: Getting Started
		slug: /
		---

		Approaching a monorepo project like this can be pretty daunting and hard to navigate for a new user.

		The goal of these docs are to give you a quick overview of the project and all of its the pieces, as well as provide guides to help you get setup.

		The docs are broken down into the following categories:

		## [I want to lint my TypeScript codebase.](./linting/README.md)
		- [I want to lint my TypeScript codebase.](./linting/README.md)

		## [(TODO) I want to write an ESLint plugin in TypeScript.](./plugin-development/README.md)
		- [(TODO) I want to write an ESLint plugin in TypeScript.](./plugin-development/README.md)