` name is static and resolvable.
-
+
@@ -37,7 +37,7 @@ The auto-fix of this rule can be replaced with a static `` name if the exp
```
-
+
## :wrench: Options
diff --git a/docs/rules/no-inner-declarations.md b/docs/rules/no-inner-declarations.md
index dc60c8fe1..4d8bf06f6 100644
--- a/docs/rules/no-inner-declarations.md
+++ b/docs/rules/no-inner-declarations.md
@@ -21,7 +21,7 @@ This rule supports [svelte-eslint-parser]'s AST.
[svelte-eslint-parser]: https://github.com/ota-meshi/svelte-eslint-parser
-
+
@@ -43,7 +43,7 @@ This rule supports [svelte-eslint-parser]'s AST.
```
-
+
## :wrench: Options
diff --git a/docs/rules/no-not-function-handler.md b/docs/rules/no-not-function-handler.md
index 6678fa801..d5da17556 100644
--- a/docs/rules/no-not-function-handler.md
+++ b/docs/rules/no-not-function-handler.md
@@ -17,7 +17,7 @@ since: "v0.5.0"
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.
-
+
@@ -43,7 +43,7 @@ If you use a non-function value for the event handler, it event handler will not
```
-
+
## :wrench: Options
diff --git a/docs/rules/no-object-in-text-mustaches.md b/docs/rules/no-object-in-text-mustaches.md
index 4c096423b..e9a9f8ce1 100644
--- a/docs/rules/no-object-in-text-mustaches.md
+++ b/docs/rules/no-object-in-text-mustaches.md
@@ -17,7 +17,7 @@ since: "v0.5.0"
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.
-
+
@@ -36,7 +36,7 @@ When you use an object for text interpolation, it is drawn as `[object Object]`.
```
-
+
## :wrench: Options
diff --git a/docs/rules/no-target-blank.md b/docs/rules/no-target-blank.md
index 43873fc3c..bd42a39c0 100644
--- a/docs/rules/no-target-blank.md
+++ b/docs/rules/no-target-blank.md
@@ -14,7 +14,7 @@ since: "v0.0.4"
This rule disallows using `target="_blank"` attribute without `rel="noopener noreferrer"` to avoid a security vulnerability([see here for more details](https://mathiasbynens.github.io/rel-noopener/)).
-
+
@@ -30,7 +30,7 @@ This rule disallows using `target="_blank"` attribute without `rel="noopener nor
link
```
-
+
## :wrench: Options
@@ -51,7 +51,7 @@ This rule disallows using `target="_blank"` attribute without `rel="noopener nor
### `{ allowReferrer: false }` (default)
-
+
@@ -67,11 +67,11 @@ This rule disallows using `target="_blank"` attribute without `rel="noopener nor
link
```
-
+
### `{ allowReferrer: true }`
-
+
@@ -87,11 +87,11 @@ This rule disallows using `target="_blank"` attribute without `rel="noopener nor
link
```
-
+
### `{ "enforceDynamicLinks": "always" }` (default)
-
+
@@ -107,11 +107,11 @@ This rule disallows using `target="_blank"` attribute without `rel="noopener nor
link
```
-
+
### `{ "enforceDynamicLinks": "never" }`
-
+
@@ -127,7 +127,7 @@ This rule disallows using `target="_blank"` attribute without `rel="noopener nor
link
```
-
+
## :rocket: Version
diff --git a/docs/rules/no-useless-mustaches.md b/docs/rules/no-useless-mustaches.md
index fc776e9de..44fb1cce8 100644
--- a/docs/rules/no-useless-mustaches.md
+++ b/docs/rules/no-useless-mustaches.md
@@ -17,7 +17,7 @@ since: "v0.0.4"
This rule reports mustache interpolation with a string literal value.
The mustache interpolation with a string literal value can be changed to a static contents.
-
+
@@ -38,7 +38,7 @@ Lorem ipsum {foo}
```
-
+
## :wrench: Options
@@ -59,7 +59,7 @@ Lorem ipsum {foo}
### `"ignoreIncludesComment": true`
-
+
@@ -75,11 +75,11 @@ Lorem ipsum {foo}
```
-
+
### `"ignoreStringEscape": true`
-
+
```svelte
@@ -87,7 +87,7 @@ Lorem ipsum {foo}
```
-
+
## :rocket: Version
diff --git a/docs/rules/prefer-class-directive.md b/docs/rules/prefer-class-directive.md
index 4d5b29c4b..7cd683172 100644
--- a/docs/rules/prefer-class-directive.md
+++ b/docs/rules/prefer-class-directive.md
@@ -16,7 +16,7 @@ since: "v0.0.1"
This rule aims to replace a class with ternary operator with the class directive.
-
+
@@ -32,7 +32,7 @@ This rule aims to replace a class with ternary operator with the class directive
```
-
+
You cannot enforce this style by using [prettier-plugin-svelte]. That is, this rule does not conflict with [prettier-plugin-svelte] and can be used with [prettier-plugin-svelte].
diff --git a/docs/rules/shorthand-attribute.md b/docs/rules/shorthand-attribute.md
index 59766cbf0..4d6606a68 100644
--- a/docs/rules/shorthand-attribute.md
+++ b/docs/rules/shorthand-attribute.md
@@ -16,7 +16,7 @@ since: "v0.5.0"
This rule enforces the use of the shorthand syntax in attribute.
-
+
@@ -35,7 +35,7 @@ This rule enforces the use of the shorthand syntax in attribute.
-
+
## :wrench: Options
diff --git a/docs/rules/spaced-html-comment.md b/docs/rules/spaced-html-comment.md
index 444cb659d..f24181d0b 100644
--- a/docs/rules/spaced-html-comment.md
+++ b/docs/rules/spaced-html-comment.md
@@ -16,7 +16,7 @@ since: "v0.0.1"
This rule will enforce consistency of spacing after the start of a comment ``.
-
+
@@ -30,7 +30,7 @@ This rule will enforce consistency of spacing after the start of a comment `
```
-
+
You cannot enforce this style by using [prettier-plugin-svelte]. That is, this rule does not conflict with [prettier-plugin-svelte] and can be used with [prettier-plugin-svelte].
diff --git a/docs/rules/valid-compile.md b/docs/rules/valid-compile.md
index 5eb17bcba..6bc9c4cf2 100644
--- a/docs/rules/valid-compile.md
+++ b/docs/rules/valid-compile.md
@@ -16,7 +16,7 @@ since: "v0.7.0"
This rule uses Svelte compiler to check the source code.
-
+
@@ -33,7 +33,7 @@ This rule uses Svelte compiler to check the source code.
![]()
```
-
+
Note that we exclude reports for some checks, such as `missing-declaration`, and `dynamic-slot-name`, which you can check with different ESLint rules.
@@ -52,7 +52,7 @@ Note that we exclude reports for some checks, such as `missing-declaration`, and
- `ignoreWarnings` ... If set to `true`, ignores any warnings other than fatal errors reported by the svelte compiler.
-
+
@@ -66,7 +66,7 @@ Note that we exclude reports for some checks, such as `missing-declaration`, and
![]()
```
-
+
## :rocket: Version
diff --git a/docs/user-guide/README.md b/docs/user-guide.md
similarity index 98%
rename from docs/user-guide/README.md
rename to docs/user-guide.md
index 0b6be57c5..f7e63ef82 100644
--- a/docs/user-guide/README.md
+++ b/docs/user-guide.md
@@ -42,7 +42,7 @@ This plugin provides configs:
- `plugin:@ota-meshi/svelte/base` ... Configuration to enable correct Svelte parsing.
- `plugin:@ota-meshi/svelte/recommended` ... Above, plus rules to prevent errors or unintended behavior.
-See [the rule list](../rules/README.md) to get the `rules` that this plugin provides.
+See [the rule list](./rules.md) to get the `rules` that this plugin provides.
::: warning ❗ Attention
diff --git a/package.json b/package.json
index 1baa0e718..961dc7fd6 100644
--- a/package.json
+++ b/package.json
@@ -25,9 +25,12 @@
"eslint-fix": "eslint . --fix",
"update": "ts-node --transpile-only ./tools/update.ts && npm run eslint-fix && npm run test",
"new": "ts-node --transpile-only ./tools/new-rule.ts",
- "predocs:watch": "npm run build:ts",
- "docs:watch": "vuepress dev --debug docs",
- "docs:build": "vuepress build docs --no-cache",
+ "docs:watch": "svelte-kit dev",
+ "docs:build": "node --experimental-loader ./svelte-kit-import-hook.mjs node_modules/@sveltejs/kit/svelte-kit.js build",
+ "docs:preview": "node --experimental-loader ./svelte-kit-import-hook.mjs node_modules/@sveltejs/kit/svelte-kit.js preview",
+ "pre_docs:watch": "npm run build:ts",
+ "_docs:watch": "vuepress dev --debug docs",
+ "_docs:build": "vuepress build docs --no-cache",
"preversion": "npm test && git add .",
"version": "env-cmd -e version npm run update && git add ."
},
@@ -64,7 +67,14 @@
}
},
"devDependencies": {
+ "@babel/core": "^7.16.0",
+ "@babel/types": "^7.16.0",
+ "@fontsource/fira-mono": "^4.5.0",
"@ota-meshi/eslint-plugin": "^0.10.0",
+ "@ota-meshi/eslint-plugin-svelte": "^0.16.0",
+ "@sindresorhus/slugify": "^2.1.0",
+ "@sveltejs/adapter-static": "^1.0.0-next.21",
+ "@sveltejs/kit": "^1.0.0-next.201",
"@types/eslint": "^8.0.0",
"@types/eslint-scope": "^3.7.0",
"@types/eslint-visitor-keys": "^1.0.0",
@@ -74,6 +84,9 @@
"@typescript-eslint/parser": "^5.4.1-0",
"@typescript-eslint/parser-v4": "npm:@typescript-eslint/parser@4",
"env-cmd": "^10.1.0",
+ "esbuild": "^0.14.1",
+ "esbuild-register": "^3.2.0",
+ "escape-html": "^1.0.3",
"eslint": "^8.0.0",
"eslint-config-prettier": "^8.3.0",
"eslint-plugin-eslint-comments": "^3.2.0",
@@ -90,17 +103,24 @@
"estree-walker": "^3.0.0",
"locate-character": "^2.0.5",
"magic-string": "^0.25.7",
+ "markdown-it-anchor": "^8.4.1",
+ "markdown-it-container": "^3.0.0",
+ "markdown-it-emoji": "^2.0.0",
"mocha": "^9.0.0",
"nyc": "^15.1.0",
"pako": "^2.0.3",
+ "pirates": "^4.0.1",
"prettier": "^2.2.1",
"prettier-plugin-svelte": "^2.2.0",
+ "prism-svelte": "^0.4.7",
+ "prismjs": "^1.25.0",
"semver": "^7.3.5",
"stylelint": "^14.0.0",
"stylelint-config-standard": "^24.0.0",
"svelte": "^3.37.0",
"ts-node": "^10.0.0",
"typescript": "^4.5.2",
+ "vite-plugin-svelte-md": "^0.1.3",
"vue-eslint-editor": "^1.1.0",
"vue-eslint-parser": "^8.0.0",
"vuepress": "^1.8.2"
diff --git a/src/rules/indent-helpers/offset-context.ts b/src/rules/indent-helpers/offset-context.ts
index fe776ce74..4a4788bfa 100644
--- a/src/rules/indent-helpers/offset-context.ts
+++ b/src/rules/indent-helpers/offset-context.ts
@@ -318,7 +318,7 @@ export class OffsetCalculator {
if (offsetInfo == null) {
continue
}
- offsetInfo.expectedIndent ??= expectedIndent
+ offsetInfo.expectedIndent = offsetInfo.expectedIndent ?? expectedIndent
}
}
}
diff --git a/src/rules/valid-compile.ts b/src/rules/valid-compile.ts
index 237b79eb2..ceba8d63c 100644
--- a/src/rules/valid-compile.ts
+++ b/src/rules/valid-compile.ts
@@ -203,8 +203,8 @@ export default createRule("valid-compile", {
this.mapIndexes.push({
range: [codeStart, this.code.length],
remap: (index) => {
- outputLocs ??= new LinesAndColumns(outputText)
- inputLocs ??= new LinesAndColumns(inputText)
+ outputLocs = outputLocs ?? new LinesAndColumns(outputText)
+ inputLocs = inputLocs ?? new LinesAndColumns(inputText)
const outputCodePos = outputLocs.getLocFromIndex(index - codeStart)
const inputCodePos = remapPosition(outputCodePos)
return inputLocs.getIndexFromLoc(inputCodePos) + start
@@ -216,7 +216,8 @@ export default createRule("valid-compile", {
line: number
column: number
} {
- decoded ??= decode(JSON.parse(output.sourceMapText!).mappings)
+ decoded =
+ decoded ?? decode(JSON.parse(output.sourceMapText!).mappings)
const lineMaps = decoded[pos.line - 1]
@@ -277,7 +278,7 @@ export default createRule("valid-compile", {
}
} {
const mapIndexes = this.mapIndexes
- const locs = (this.locs ??= new LinesAndColumns(this.code))
+ const locs = (this.locs = this.locs ?? new LinesAndColumns(this.code))
let start:
| {
line: number
diff --git a/src/utils/eslint-core.ts b/src/utils/eslint-core.ts
index 7d9be9d17..5450ba28d 100644
--- a/src/utils/eslint-core.ts
+++ b/src/utils/eslint-core.ts
@@ -2,6 +2,7 @@
import type { RuleListener, RuleContext, RuleModule } from "../types"
import type * as ESTree from "estree"
import type { AST as SvAST } from "svelte-eslint-parser"
+import { Linter } from "eslint"
/**
* Define the wrapped core rule.
@@ -82,8 +83,7 @@ export function getCoreRule(ruleName: string): RuleModule {
if (ruleMap) {
map = ruleMap
} else {
- // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -- load eslint
- ruleMap = map = new (require("eslint").Linter)().getRules()
+ ruleMap = map = (new Linter() as any).getRules()
}
return map.get(ruleName)!
}
diff --git a/src/utils/index.ts b/src/utils/index.ts
index 6ce7d340c..febe653f3 100644
--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -14,7 +14,7 @@ export function createRule(
...rule.meta,
docs: {
...rule.meta.docs,
- url: `https://ota-meshi.github.io/eslint-plugin-svelte/rules/${ruleName}.html`,
+ url: `https://ota-meshi.github.io/eslint-plugin-svelte/rules/${ruleName}`,
ruleId: `@ota-meshi/svelte/${ruleName}`,
ruleName,
},
diff --git a/svelte-kit-import-hook.mjs b/svelte-kit-import-hook.mjs
new file mode 100644
index 000000000..aa564d2e4
--- /dev/null
+++ b/svelte-kit-import-hook.mjs
@@ -0,0 +1,99 @@
+/* !! This project can't be ESM yet, so hack it to get sveltekit to work. !! */
+import babelCore from "@babel/core"
+import * as t from "@babel/types"
+
+import pirates from "pirates"
+
+pirates.addHook(transform, {
+ exts: [".js", ".mjs"],
+})
+
+/** transform code */
+function transform(code, _filename) {
+ if (code.includes("import(")) {
+ let transformed = false
+ const newCode = babelCore.transformSync(code, {
+ babelrc: false,
+ plugins: [
+ {
+ visitor: {
+ CallExpression(path) {
+ const callee = path.get("callee")
+ if (callee.type === "Import") {
+ callee.replaceWith(t.identifier("$$$import"))
+ transformed = true
+ }
+ },
+ },
+ },
+ ],
+ })
+ if (!transformed) {
+ return code
+ }
+ return `${newCode.code}
+async function $$$import(module, ...args) {
+ const m = await import(module)
+ return ________adjustModule(m)
+}
+function ________adjustModule(m) {
+ const keys = Object.keys(m);
+ if(m.default && keys.length === 1 && keys[0] === 'default' && typeof m.default === 'object') {
+ const result = {
+ default: ________adjustModule(m.default)
+ }
+ for (const key of Object.keys(m.default)) {
+ if (typeof m.default[key] === 'function') {
+ result[key] = (...args) => m.default[key](...args);
+ } else {
+ result[key] = m.default[key]
+ }
+ }
+ return result
+ }
+ return m
+}
+`
+ }
+
+ return code
+}
+
+/**
+ * @param {string} url
+ * @param {{
+ * format: string,
+ * }} context If resolve settled with a `format`, that value is included here.
+ * @param {Function} defaultLoad
+ * @returns {Promise<{
+ * format: !string,
+ * source: !(string | ArrayBuffer | SharedArrayBuffer | Uint8Array),
+ * }>}
+ */
+export async function load(url, context, defaultLoad) {
+ const result = await defaultLoad(url, context, defaultLoad)
+ return {
+ format: result.format,
+ source: transform(`${result.source}`),
+ }
+}
+
+/**
+ * @param {!(string | SharedArrayBuffer | Uint8Array)} source
+ * @param {{
+ * format: string,
+ * url: string,
+ * }} context
+ * @param {Function} defaultTransformSource
+ * @returns {Promise<{ source: !(string | SharedArrayBuffer | Uint8Array) }>}
+ */
+export async function transformSource(source, context, defaultTransformSource) {
+ const result = await defaultTransformSource(
+ source,
+ context,
+ defaultTransformSource,
+ )
+ return {
+ source: transform(`${result.source}`),
+ }
+}
diff --git a/svelte.config.esm.mjs b/svelte.config.esm.mjs
new file mode 100644
index 000000000..e1158d52d
--- /dev/null
+++ b/svelte.config.esm.mjs
@@ -0,0 +1,60 @@
+/* global __dirname -- __dirname */
+import staticAdapter from "@sveltejs/adapter-static"
+import path from "path"
+import svelteMd from "vite-plugin-svelte-md"
+import svelteMdOption from "./docs-svelte-kit/tools/vite-plugin-svelte-md-option.mjs"
+
+import "./docs-svelte-kit/build-system/build.js"
+
+const dirname =
+ typeof __dirname !== "undefined"
+ ? __dirname
+ : (() => {
+ const metaUrl = Function(`return import.meta.url`)()
+ return path.dirname(new URL(metaUrl).pathname)
+ })()
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+ compilerOptions: {
+ preserveWhitespace: true,
+ },
+ extensions: [".svelte", ".md"],
+ kit: {
+ paths: {
+ base: "/eslint-plugin-svelte",
+ },
+ adapter: staticAdapter({
+ // default options are shown
+ pages: "build",
+ assets: "build",
+ }),
+
+ // hydrate the element in src/app.html
+ target: "#svelte",
+ files: {
+ routes: path.join(dirname, "./docs"),
+ template: path.join(dirname, "./docs-svelte-kit/src/app.html"),
+ hooks: path.join(dirname, "./docs-svelte-kit/src/hooks"),
+ lib: path.join(dirname, "./docs-svelte-kit/src/lib"),
+ assets: path.join(dirname, "./docs-svelte-kit/statics"),
+ },
+
+ vite: {
+ server: {
+ fs: { strict: false },
+ },
+ resolve: {
+ alias: {
+ eslint: path.join(dirname, "./docs-svelte-kit/shim/eslint.mjs"),
+ assert: path.join(dirname, "./docs-svelte-kit/shim/assert.mjs"),
+ module: path.join(dirname, "./docs-svelte-kit/shim/module.mjs"),
+ path: path.join(dirname, "./docs-svelte-kit/shim/path.mjs"),
+ url: path.join(dirname, "./docs-svelte-kit/shim/url.mjs"),
+ os: path.join(dirname, "./docs-svelte-kit/shim/os.mjs"),
+ },
+ },
+ plugins: [svelteMd(svelteMdOption)],
+ },
+ },
+}
+export default config
diff --git a/svelte.config.js b/svelte.config.js
new file mode 100644
index 000000000..b42d75340
--- /dev/null
+++ b/svelte.config.js
@@ -0,0 +1,28 @@
+"use strict"
+
+/* !! This project can't be ESM yet, so hack it to get sveltekit to work. !! */
+const esbuild = require("esbuild")
+const path = require("path")
+
+esbuild.buildSync({
+ entryPoints: [require.resolve("./svelte.config.esm.mjs")],
+ outfile: path.join(__dirname, "./svelte.config-dist.js"),
+ format: "cjs",
+ bundle: true,
+ external: [
+ "path",
+ "cross-spawn",
+ "prismjs",
+ "./docs-svelte-kit/build-system/build.js",
+ ],
+})
+const { register } = require("esbuild-register/dist/node")
+register({
+ format: "cjs",
+ extensions: [".js", ".mjs", ".cjs", ".ts"],
+})
+
+/* eslint node/no-missing-require: 0 -- ignore */
+const config = require("./svelte.config-dist.js").default
+
+module.exports = config
diff --git a/tools/new-rule.ts b/tools/new-rule.ts
index 9d9644fc0..6ae1dd327 100644
--- a/tools/new-rule.ts
+++ b/tools/new-rule.ts
@@ -80,7 +80,7 @@ tester.run("${ruleId}", rule as any, loadTestCases("${ruleId}"))
This rule reports ???.
-
+
@@ -95,7 +95,7 @@ This rule reports ???.
\`\`\`
-
+
## :wrench: Options
diff --git a/tools/render-rules.ts b/tools/render-rules.ts
index 31b82b392..5863a56a0 100644
--- a/tools/render-rules.ts
+++ b/tools/render-rules.ts
@@ -43,7 +43,7 @@ const categoryRules = categories.map((cat) => {
//eslint-disable-next-line require-jsdoc -- ignore
export default function renderRulesTableContent(
- buildRulePath = (ruleName: string) => `./${ruleName}.md`,
+ buildRulePath = (ruleName: string) => `./rules/${ruleName}.md`,
): string {
// -----------------------------------------------------------------------------
diff --git a/tools/update-docs-rules-index.ts b/tools/update-docs-rules-index.ts
index df64faa81..f650d2e33 100644
--- a/tools/update-docs-rules-index.ts
+++ b/tools/update-docs-rules-index.ts
@@ -3,7 +3,7 @@ import fs from "fs"
import renderRulesTableContent from "./render-rules"
// -----------------------------------------------------------------------------
-const readmeFilePath = path.resolve(__dirname, "../docs/rules/README.md")
+const readmeFilePath = path.resolve(__dirname, "../docs/rules.md")
fs.writeFileSync(
readmeFilePath,
`---
diff --git a/tools/update-docs.ts b/tools/update-docs.ts
index e73d43b78..90adfb3da 100644
--- a/tools/update-docs.ts
+++ b/tools/update-docs.ts
@@ -167,7 +167,7 @@ ${
const { meta } = this.rule
this.content = this.content.replace(
- //gu,
+ //gu,
(_t, str) => {
const ps = str
.split(/\s+/u)
@@ -176,7 +176,7 @@ ${
if (meta.fixable) {
ps.unshift("fix")
}
- ps.unshift("`
},
)
@@ -186,12 +186,12 @@ ${
public adjustCodeBlocks() {
// Adjust the necessary blank lines before and after the code block so that GitHub can recognize `.md`.
this.content = this.content.replace(
- /()\n+```/gu,
+ /()\n+```/gu,
"$1\n\n```",
)
this.content = this.content.replace(
- /```\n+<\/eslint-code-block>/gu,
- "```\n\n",
+ /```\n+<\/ESLintCodeBlock>/gu,
+ "```\n\n",
)
return this
}
diff --git a/tools/update-readme.ts b/tools/update-readme.ts
index 5db0a80b1..2393c97fe 100644
--- a/tools/update-readme.ts
+++ b/tools/update-readme.ts
@@ -3,8 +3,7 @@ import fs from "fs"
import renderRulesTableContent from "./render-rules"
const insertText = `\n${renderRulesTableContent(
- (name) =>
- `https://ota-meshi.github.io/eslint-plugin-svelte/rules/${name}.html`,
+ (name) => `https://ota-meshi.github.io/eslint-plugin-svelte/rules/${name}`,
)}\n`
const readmeFilePath = path.resolve(__dirname, "../README.md")
@@ -23,31 +22,39 @@ const docsReadmeFilePath = path.resolve(__dirname, "../docs/README.md")
fs.writeFileSync(
docsReadmeFilePath,
- newReadme
- .replace("# @ota-meshi/eslint-plugin-svelte\n", "# Introduction\n")
- .replace(
- /[\s\S]*/u,
- "See [Available Rules](./rules/README.md).",
- )
- .replace(
- /[\s\S]*/u,
- "See [User Guide](./user-guide/README.md).",
- )
- .replace(/[\s\S]*?/gu, "")
- .replace(
- // eslint-disable-next-line regexp/no-super-linear-backtracking -- ignore
- /\(https:\/\/ota-meshi.github.io\/eslint-plugin-svelte(.*?)([^/]*\.html)?\)/gu,
- (_ptn, c1: string, c2: string) => {
- let result = `(.${c1}`
- if (c2) {
- result +=
- c2 === "index.html" ? "README.md" : c2.replace(/\.html$/, ".md")
- } else {
- result += "README.md"
- }
- result += ")"
- return result
- },
- )
- .replace(/\n{3,}/gu, "\n\n"),
+ `---
+title: "@ota-meshi/eslint-plugin-svelte"
+---
+
+${newReadme
+ .replace("# @ota-meshi/eslint-plugin-svelte\n", "# Introduction\n")
+ .replace(
+ /[\s\S]*/u,
+ "See [Available Rules](./rules.md).",
+ )
+ .replace(
+ /[\s\S]*/u,
+ "See [User Guide](./user-guide.md).",
+ )
+ .replace(/[\s\S]*?/gu, "")
+ .replace(
+ // eslint-disable-next-line regexp/no-super-linear-backtracking -- ignore
+ /\(https:\/\/ota-meshi.github.io\/eslint-plugin-svelte(.*?)([^/]*\.html)?\)/gu,
+ (_ptn, c1: string, c2: string) => {
+ let result = `(.${c1}`
+ if (c2) {
+ result +=
+ c2 === "index.html" ? "README.md" : c2.replace(/\.html$/, ".md")
+ } else {
+ result += ".md"
+ }
+ result += ")"
+ return result
+ },
+ )
+ .replace(
+ "[LICENSE](LICENSE)",
+ "[LICENSE](https://github.com/ota-meshi/eslint-plugin-svelte/blob/main/LICENSE)",
+ )
+ .replace(/\n{3,}/gu, "\n\n")}`,
)
+
+