ci: enable CI tools and linters

close #166

Author: JounQin

.browserslistrc

@@ -0,0 +1 @@
+extends @1stg/browserslist-config/modern

.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)

.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": []
+}

.codesandbox/ci.json

@@ -0,0 +1,4 @@
+{
+  "node": "16",
+  "sandboxes": []
+}

.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@1stg"
+}

.eslintignore

@@ -16,3 +16,4 @@
 /build
 /docs-svelte-kit/shim/eslint.mjs
 /docs-svelte-kit/shim/assert.mjs
+!/.*.js

.eslintrc.js

@@ -15,8 +15,8 @@ module.exports = {
     "plugin:@ota-meshi/+eslint-plugin",
     "plugin:@ota-meshi/+package-json",
     "plugin:@ota-meshi/+json",
-    "plugin:@ota-meshi/+yaml",
     "plugin:@ota-meshi/+md",
+    "plugin:@ota-meshi/+yaml",
     "plugin:@ota-meshi/+prettier",
   ],
   rules: {
@@ -35,6 +35,13 @@ module.exports = {
     ],
   },
   overrides: [
+    {
+      files: ["*.md"],
+      extends: "plugin:mdx/recommended",
+      settings: {
+        "mdx/code-blocks": true,
+      },
+    },
     {
       files: ["*.mjs"],
       parserOptions: {

.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

.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 }}

.gitignore

@@ -104,6 +104,7 @@ dist
 /yarn.lock
 /lib
 /.svelte-kit
+/.type-coverage
 /build
 /svelte.config-dist.js
 /docs-svelte-kit/shim/eslint.mjs

.remarkrc.json

@@ -0,0 +1,7 @@
+{
+  "plugins": [
+    "@1stg/remark-config",
+    ["lint-final-definition", false],
+    ["lint-no-shortcut-reference-link", false]
+  ]
+}

.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/

README.md

@@ -4,22 +4,22 @@ title: "eslint-plugin-svelte"
 
 # Introduction
 
-`eslint-plugin-svelte` is [ESLint] plugin for [Svelte].  
-It provides many unique check rules by using the template AST.  
+`eslint-plugin-svelte` is [ESLint] plugin for [Svelte].\
+It provides many unique check rules by using the template AST.\
 You can check on the [Online DEMO](./playground.md).
 
 [![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
 [![NPM version](https://img.shields.io/npm/v/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte)
+[![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads\&colorB=green\&suffix=/day\&query=$.downloads\&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte\&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dw/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dm/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![NPM downloads](https://img.shields.io/npm/dy/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
 [![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)
 
-## :name_badge: What is this plugin?
+## :name\_badge: What is this plugin?
 
-[ESLint] plugin for [Svelte].  
+[ESLint] plugin for [Svelte].\
 It provides many unique check rules using the AST generated by [svelte-eslint-parser].
 
 ### ❓ Why?
@@ -39,7 +39,7 @@ The [svelte-eslint-parser] and the `eslint-plugin-svelte` can not be used with t
 
 See [User Guide](./user-guide.md).
 
-## :white_check_mark: Rules
+## :white\_check\_mark: Rules
 
 See [Available Rules](./rules.md).
 

docs/README.md

@@ -10,19 +10,19 @@ If you want the previous behavior, replace it with [eslint-plugin-svelte3].
 
 ## From `@ota-meshi/eslint-plugin-svelte`
 
-`@ota-meshi/eslint-plugin-svelte` has been renamed to `eslint-plugin-svelte`.  
+`@ota-meshi/eslint-plugin-svelte` has been renamed to `eslint-plugin-svelte`.\
 Therefore, you need to replace the package name, and the presets, rules, and settings specified in the configuration.
 
-- `package.json`  
+- `package.json`\
   Replace the package name.
 
   ```diff
   -  "@ota-meshi/eslint-plugin-svelte": "^0.X.X"
   +  "eslint-plugin-svelte": "^X.X.X"
   ```
 
-- `.eslintrc.*`  
-  Replace `@ota-meshi/svelte` with `svelte` as a string.  
+- `.eslintrc.*`\
+  Replace `@ota-meshi/svelte` with `svelte` as a string.\
   Examples:
 
   - Presets

docs/migration.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

docs/rules/first-attribute-linebreak.md

@@ -42,7 +42,7 @@ Nothing.
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].  
+This rule was taken from [@tivac/eslint-plugin-svelte].\
 This rule is compatible with `@tivac/svelte/reactive-curlies` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/

docs/rules/no-extra-reactive-curlies.md

@@ -16,7 +16,7 @@ since: "v0.0.8"
 
 This rule requires that function declarations and, optionally, variable declarations be in the root of a program or the body of a function.
 
-This rule extends the base ESLint's [no-inner-declarations] rule. The AST generated by [svelte-eslint-parser] will false positives in [no-inner-declarations] rule because the root node of the script is not the `Program`.  
+This rule extends the base ESLint's [no-inner-declarations] rule. The AST generated by [svelte-eslint-parser] will false positives in [no-inner-declarations] rule because the root node of the script is not the `Program`.\
 This rule supports [svelte-eslint-parser]'s AST.
 
 [svelte-eslint-parser]: https://github.com/ota-meshi/svelte-eslint-parser

docs/rules/no-inner-declarations.md

@@ -14,7 +14,7 @@ since: "v0.5.0"
 
 ## :book: Rule Details
 
-This rule reports where you used not function value in event handlers.  
+This rule reports where you used not function value in event handlers.\
 If you use a non-function value for the event handler, it event handler will not be called. It's almost always a mistake. You may have written a lot of unnecessary curly braces.
 
 <ESLintCodeBlock>

docs/rules/no-not-function-handler.md

@@ -14,7 +14,7 @@ since: "v0.5.0"
 
 ## :book: Rule Details
 
-This rule disallows the use of objects in text mustache interpolation.  
+This rule disallows the use of objects in text mustache interpolation.\
 When you use an object for text interpolation, it is drawn as `[object Object]`. It's almost always a mistake. You may have written a lot of unnecessary curly braces.
 
 <ESLintCodeBlock>

docs/rules/no-object-in-text-mustaches.md

@@ -42,10 +42,11 @@ Nothing
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].  
+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

docs/rules/no-reactive-functions.md

@@ -39,7 +39,7 @@ Nothing.
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].  
+This rule was taken from [@tivac/eslint-plugin-svelte].\
 This rule is compatible with `@tivac/svelte/reactive-literals` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/

docs/rules/no-reactive-literals.md

@@ -21,6 +21,7 @@ Style directive were added in Svelte v3.46.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte

docs/rules/prefer-style-directive.md

@@ -42,7 +42,7 @@ Nothing.
 
 ## :heart: Compatibility
 
-This rule was taken from [@tivac/eslint-plugin-svelte].  
+This rule was taken from [@tivac/eslint-plugin-svelte].\
 This rule is compatible with `@tivac/svelte/stores-initial-value` rule.
 
 [@tivac/eslint-plugin-svelte]: https://github.com/tivac/eslint-plugin-svelte/

docs/rules/require-stores-init.md

@@ -19,6 +19,7 @@ This rule enforces the use of the shorthand syntax in attribute.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte

docs/rules/shorthand-attribute.md

@@ -19,6 +19,7 @@ This rule enforces the use of the shorthand syntax in directives.
 <ESLintCodeBlock fix>
 
 <!-- prettier-ignore-start -->
+
 <!--eslint-skip-->
 
 ```svelte

docs/rules/shorthand-directive.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
 

docs/rules/spaced-html-comment.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,13 +134,13 @@ 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
 
 You can change the behavior of this plugin with some settings.
 
-- `ignoreWarnings` (optional) ... Specifies an array of rules that ignore reports in the template.  
+- `ignoreWarnings` (optional) ... Specifies an array of rules that ignore reports in the template.\
   For example, set rules on the template that cannot avoid false positives.
 - `compileOptions` (optional) ... Specifies options for Svelte compile. Effects rules that use Svelte compile. The target rules are [svelte/valid-compile](./rules/valid-compile.md) and [svelte/no-unused-svelte-ignore](./rules/no-unused-svelte-ignore.md). **Note that it has no effect on ESLint's custom parser**.
   - `postcss` (optional) ... Specifies options related to PostCSS. You can disable the PostCSS process by specifying `false`.

docs/user-guide.md

@@ -0,0 +1,3 @@
+"use strict"
+
+module.exports = require("@1stg/lint-staged/tsc")