ci: enable CI tools and linters (#220)

JounQin · web-flow · commit 7c8d0534498e · 2022-08-13T07:24:57.000+08:00
diff --git a/.browserslistrc b/.browserslistrc
@@ -0,0 +1 @@
+extends @1stg/browserslist-config/modern
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    {
+      "repo": "ota-meshi/eslint-plugin-svelte"
+    }
+  ],
+  "commit": false,
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}
diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json
@@ -0,0 +1,4 @@
+{
+  "node": "16",
+  "sandboxes": []
+}
diff --git a/.commitlintrc.json b/.commitlintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "@1stg"
+}
diff --git a/.eslintignore b/.eslintignore
@@ -16,3 +16,4 @@
 /build
 /docs-svelte-kit/shim/eslint.mjs
 /docs-svelte-kit/shim/assert.mjs
+!/.*.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -35,6 +35,13 @@ module.exports = {
     ],
   },
   overrides: [
+    {
+      files: ["*.md"],
+      extends: "plugin:mdx/recommended",
+      settings: {
+        "mdx/code-blocks": true,
+      },
+    },
     {
       files: ["*.mjs"],
       parserOptions: {
diff --git a/.github/workflows/NodeCI.yml b/.github/workflows/NodeCI.yml
@@ -53,3 +53,5 @@ jobs:
         run: yarn install --ignore-engines
       - name: Test
         run: yarn test
+      - name: Type Coverage
+        run: yarn typecov
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install Dependencies
+        run: yarn
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          # This expects you to have a script called release which does a build for your packages and calls changeset publish
+          publish: yarn release
+          commit: "chore: release eslint-plugin-svelte"
+          title: "chore: release eslint-plugin-svelte"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -104,6 +104,7 @@ dist
 /yarn.lock
 /lib
 /.svelte-kit
+/.type-coverage
 /build
 /svelte.config-dist.js
 /docs-svelte-kit/shim/eslint.mjs
diff --git a/.remarkrc.json b/.remarkrc.json
@@ -0,0 +1,7 @@
+{
+  "plugins": [
+    "@1stg/remark-config",
+    ["lint-final-definition", false],
+    ["lint-no-shortcut-reference-link", false]
+  ]
+}
diff --git a/.stylelintignore b/.stylelintignore
@@ -0,0 +1,15 @@
+.*ignore
+.npmrc
+LICENSE
+*.png
+*.json
+*.lock
+*.log
+*.svg
+*.yaml
+*.yml
+/tests/fixtures/rules
+# TODO: enable the following
+# should we ignore markdown files?
+*.md
+/docs-svelte-kit/
diff --git a/README.md b/README.md
@@ -13,6 +13,12 @@ You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-sve
 [![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![Build Status](https://github.com/ota-meshi/eslint-plugin-svelte/workflows/CI/badge.svg?branch=main)](https://github.com/ota-meshi/eslint-plugin-svelte/actions?query=workflow%3ACI)
 
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ota-meshi/eslint-plugin-svelte.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ota-meshi/eslint-plugin-svelte/context:javascript)
+[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fota-meshi%2Feslint-plugin-svelte%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
+[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/atlassian/changesets)
+
 ## :name_badge: What is this plugin?
 
 [ESLint] plugin for [Svelte].  
@@ -61,7 +67,7 @@ npm install --save-dev eslint eslint-plugin-svelte svelte
 
 ### Configuration
 
-Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
+Use `.eslintrc.*` file to configure rules. See also: <https://eslint.org/docs/user-guide/configuring>.
 
 Example **.eslintrc.js**:
 
@@ -176,7 +182,7 @@ module.exports = {
 }
 ```
 
-See also [https://github.com/ota-meshi/svelte-eslint-parser#readme](https://github.com/ota-meshi/svelte-eslint-parser#readme).
+See also <https://github.com/ota-meshi/svelte-eslint-parser#readme>.
 
 #### settings.svelte
 
@@ -242,6 +248,7 @@ Example **.vscode/settings.json**:
 
 ## :white_check_mark: Rules
 
+<!-- prettier-ignore-start -->
 <!--RULES_SECTION_START-->
 
 :wrench: Indicates that the rule is fixable, and using `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the reported problems.  
@@ -330,6 +337,7 @@ These rules relate to this plugin works:
 
 <!--RULES_TABLE_END-->
 <!--RULES_SECTION_END-->
+<!-- prettier-ignore-end -->
 
 <!--DOCS_IGNORE_START-->
 
diff --git a/docs/README.md b/docs/README.md
@@ -17,6 +17,12 @@ You can check on the [Online DEMO](./playground.md).
 [![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![Build Status](https://github.com/ota-meshi/eslint-plugin-svelte/workflows/CI/badge.svg?branch=main)](https://github.com/ota-meshi/eslint-plugin-svelte/actions?query=workflow%3ACI)
 
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ota-meshi/eslint-plugin-svelte.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ota-meshi/eslint-plugin-svelte/context:javascript)
+[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fota-meshi%2Feslint-plugin-svelte%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
+[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/atlassian/changesets)
+
 ## :name_badge: What is this plugin?
 
 [ESLint] plugin for [Svelte].  
@@ -41,7 +47,9 @@ See [User Guide](./user-guide.md).
 
 ## :white_check_mark: Rules
 
+<!-- prettier-ignore-start -->
 See [Available Rules](./rules.md).
+<!-- prettier-ignore-end -->
 
 ## :lock: License
 
diff --git a/docs/rules/first-attribute-linebreak.md b/docs/rules/first-attribute-linebreak.md
@@ -19,6 +19,7 @@ This rule aims to enforce a consistent location for the first attribute.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte
diff --git a/docs/rules/no-reactive-functions.md b/docs/rules/no-reactive-functions.md
@@ -25,12 +25,20 @@ This rule reports whenever a function is defined in a reactive statement. This i
   /* eslint svelte/no-reactive-functions: "error" */
 
   /* ✓ GOOD */
-  const arrowFn = () => { /* ... */ }
-  const func = function() { /* ... */ }
-  
+  const arrowFn = () => {
+    /* ... */
+  }
+  const func = function () {
+    /* ... */
+  }
+
   /* ✗ BAD */
-  $: arrowFn = () => { /* ... */ }
-  $: func = function() { /* ... */ }
+  $: arrowFn = () => {
+    /* ... */
+  }
+  $: func = function () {
+    /* ... */
+  }
 </script>
 ```
 
@@ -46,6 +54,7 @@ This rule was taken from [@tivac/eslint-plugin-svelte].
 This rule is compatible with `@tivac/svelte/reactive-functions` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/
+
 ## :rocket: Version
 
 This rule was introduced in eslint-plugin-svelte v2.5.0
diff --git a/docs/rules/prefer-style-directive.md b/docs/rules/prefer-style-directive.md
@@ -21,6 +21,7 @@ Style directive were added in Svelte v3.46.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte
diff --git a/docs/rules/shorthand-attribute.md b/docs/rules/shorthand-attribute.md
@@ -19,6 +19,7 @@ This rule enforces the use of the shorthand syntax in attribute.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte
diff --git a/docs/rules/shorthand-directive.md b/docs/rules/shorthand-directive.md
@@ -19,6 +19,7 @@ This rule enforces the use of the shorthand syntax in directives.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte
diff --git a/docs/rules/spaced-html-comment.md b/docs/rules/spaced-html-comment.md
@@ -48,7 +48,7 @@ You cannot enforce this style by using [prettier-plugin-svelte]. That is, this r
 ```
 
 - `"always"` ... There must be at least one whitespace after `<!--` and before `-->`.
-- `"never"` ... There should be no leading or trailing whitespace.　 There should be no whitespace following.
+- `"never"` ... There should be no leading or trailing whitespace. There should be no whitespace following.
 
 ## :rocket: Version
 
diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -19,7 +19,7 @@ npm install --save-dev eslint eslint-plugin-svelte svelte
 
 ### Configuration
 
-Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
+Use `.eslintrc.*` file to configure rules. See also: <https://eslint.org/docs/user-guide/configuring>.
 
 Example **.eslintrc.js**:
 
@@ -134,7 +134,7 @@ module.exports = {
 }
 ```
 
-See also [https://github.com/ota-meshi/svelte-eslint-parser#readme](https://github.com/ota-meshi/svelte-eslint-parser#readme).
+See also <https://github.com/ota-meshi/svelte-eslint-parser#readme>.
 
 #### settings.svelte
 
diff --git a/lint-staged.config.js b/lint-staged.config.js
@@ -0,0 +1,3 @@
+"use strict"
+
+module.exports = require("@1stg/lint-staged/tsc")
diff --git a/package.json b/package.json
diff --git a/simple-git-hooks.js b/simple-git-hooks.js
diff --git a/stylelint.config.js b/stylelint.config.js
diff --git a/tests/fixtures/rules/indent/valid/pug01-input.svelte b/tests/fixtures/rules/indent/valid/pug01-input.svelte
diff --git a/tests/utils/source-code-fixer.ts b/tests/utils/source-code-fixer.ts
diff --git a/tests/utils/utils.ts b/tests/utils/utils.ts
diff --git a/tools/update-readme.ts b/tools/update-readme.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+extends @1stg/browserslist-config/modern`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+"use strict"`
	`2`	`+`
	`3`	`+module.exports = require("@1stg/lint-staged/tsc")`