From 0be399a20a38985e82c3ccc8883ea154edc370ef Mon Sep 17 00:00:00 2001 From: Josh Wilson Date: Sat, 7 Sep 2024 13:25:30 -0400 Subject: [PATCH] Fix documentation URLs, closes #158. --- eslint.config.mjs | 2 +- .../eslint-plugin-solid/src/rules/components-return-once.ts | 2 +- packages/eslint-plugin-solid/src/rules/event-handlers.ts | 2 +- packages/eslint-plugin-solid/src/rules/imports.ts | 2 +- .../eslint-plugin-solid/src/rules/jsx-no-duplicate-props.ts | 2 +- packages/eslint-plugin-solid/src/rules/jsx-no-script-url.ts | 2 +- packages/eslint-plugin-solid/src/rules/jsx-no-undef.ts | 2 +- packages/eslint-plugin-solid/src/rules/jsx-uses-vars.ts | 2 +- packages/eslint-plugin-solid/src/rules/no-array-handlers.ts | 2 +- packages/eslint-plugin-solid/src/rules/no-destructure.ts | 2 +- packages/eslint-plugin-solid/src/rules/no-innerhtml.ts | 2 +- packages/eslint-plugin-solid/src/rules/no-proxy-apis.ts | 2 +- packages/eslint-plugin-solid/src/rules/no-react-deps.ts | 2 +- .../eslint-plugin-solid/src/rules/no-react-specific-props.ts | 2 +- packages/eslint-plugin-solid/src/rules/no-unknown-namespaces.ts | 2 +- packages/eslint-plugin-solid/src/rules/prefer-classlist.ts | 2 +- packages/eslint-plugin-solid/src/rules/prefer-for.ts | 2 +- packages/eslint-plugin-solid/src/rules/prefer-show.ts | 2 +- packages/eslint-plugin-solid/src/rules/reactivity.ts | 2 +- packages/eslint-plugin-solid/src/rules/self-closing-comp.ts | 2 +- packages/eslint-plugin-solid/src/rules/style-prop.ts | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/eslint.config.mjs b/eslint.config.mjs index c4d5758..b5a0060 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -55,7 +55,7 @@ export default tseslint.config( "error", { pattern: - "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/{{name}}.md", + "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/{{name}}.md", }, ], }, diff --git a/packages/eslint-plugin-solid/src/rules/components-return-once.ts b/packages/eslint-plugin-solid/src/rules/components-return-once.ts index d4baa4d..6b93113 100644 --- a/packages/eslint-plugin-solid/src/rules/components-return-once.ts +++ b/packages/eslint-plugin-solid/src/rules/components-return-once.ts @@ -34,7 +34,7 @@ export default createRule({ docs: { description: "Disallow early returns in components. Solid components only run once, and so conditionals should be inside JSX.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/components-return-once.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/components-return-once.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/event-handlers.ts b/packages/eslint-plugin-solid/src/rules/event-handlers.ts index c3e6315..f60885f 100644 --- a/packages/eslint-plugin-solid/src/rules/event-handlers.ts +++ b/packages/eslint-plugin-solid/src/rules/event-handlers.ts @@ -116,7 +116,7 @@ export default createRule({ docs: { description: "Enforce naming DOM element event handlers consistently and prevent Solid's analysis from misunderstanding whether a prop should be an event handler.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/event-handlers.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/event-handlers.md", }, fixable: "code", hasSuggestions: true, diff --git a/packages/eslint-plugin-solid/src/rules/imports.ts b/packages/eslint-plugin-solid/src/rules/imports.ts index efb3394..502c2f8 100644 --- a/packages/eslint-plugin-solid/src/rules/imports.ts +++ b/packages/eslint-plugin-solid/src/rules/imports.ts @@ -130,7 +130,7 @@ export default createRule({ docs: { description: 'Enforce consistent imports from "solid-js", "solid-js/web", and "solid-js/store".', - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/imports.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/imports.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/jsx-no-duplicate-props.ts b/packages/eslint-plugin-solid/src/rules/jsx-no-duplicate-props.ts index 0f6a57a..b401a6d 100644 --- a/packages/eslint-plugin-solid/src/rules/jsx-no-duplicate-props.ts +++ b/packages/eslint-plugin-solid/src/rules/jsx-no-duplicate-props.ts @@ -24,7 +24,7 @@ export default createRule({ type: "problem", docs: { description: "Disallow passing the same prop twice in JSX.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/jsx-no-duplicate-props.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-duplicate-props.md", }, schema: [ { diff --git a/packages/eslint-plugin-solid/src/rules/jsx-no-script-url.ts b/packages/eslint-plugin-solid/src/rules/jsx-no-script-url.ts index 4d4492b..228ed9c 100644 --- a/packages/eslint-plugin-solid/src/rules/jsx-no-script-url.ts +++ b/packages/eslint-plugin-solid/src/rules/jsx-no-script-url.ts @@ -32,7 +32,7 @@ export default createRule({ type: "problem", docs: { description: "Disallow javascript: URLs.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/jsx-no-script-url.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-script-url.md", }, schema: [], messages: { diff --git a/packages/eslint-plugin-solid/src/rules/jsx-no-undef.ts b/packages/eslint-plugin-solid/src/rules/jsx-no-undef.ts index 15ec61c..2ad5690 100644 --- a/packages/eslint-plugin-solid/src/rules/jsx-no-undef.ts +++ b/packages/eslint-plugin-solid/src/rules/jsx-no-undef.ts @@ -33,7 +33,7 @@ export default createRule({ type: "problem", docs: { description: "Disallow references to undefined variables in JSX. Handles custom directives.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/jsx-no-undef.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-undef.md", }, fixable: "code", schema: [ diff --git a/packages/eslint-plugin-solid/src/rules/jsx-uses-vars.ts b/packages/eslint-plugin-solid/src/rules/jsx-uses-vars.ts index b20a5b7..0c3eca6 100644 --- a/packages/eslint-plugin-solid/src/rules/jsx-uses-vars.ts +++ b/packages/eslint-plugin-solid/src/rules/jsx-uses-vars.ts @@ -23,7 +23,7 @@ export default createRule({ docs: { // eslint-disable-next-line eslint-plugin/require-meta-docs-description description: "Prevent variables used in JSX from being marked as unused.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/jsx-uses-vars.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-uses-vars.md", }, schema: [], // eslint-disable-next-line eslint-plugin/prefer-message-ids diff --git a/packages/eslint-plugin-solid/src/rules/no-array-handlers.ts b/packages/eslint-plugin-solid/src/rules/no-array-handlers.ts index a9487de..0e85246 100644 --- a/packages/eslint-plugin-solid/src/rules/no-array-handlers.ts +++ b/packages/eslint-plugin-solid/src/rules/no-array-handlers.ts @@ -16,7 +16,7 @@ export default createRule({ type: "problem", docs: { description: "Disallow usage of type-unsafe event handlers.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-array-handlers.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-array-handlers.md", }, schema: [], messages: { diff --git a/packages/eslint-plugin-solid/src/rules/no-destructure.ts b/packages/eslint-plugin-solid/src/rules/no-destructure.ts index e29170c..1e3c026 100644 --- a/packages/eslint-plugin-solid/src/rules/no-destructure.ts +++ b/packages/eslint-plugin-solid/src/rules/no-destructure.ts @@ -46,7 +46,7 @@ export default createRule({ docs: { description: "Disallow destructuring props. In Solid, props must be used with property accesses (`props.foo`) to preserve reactivity. This rule only tracks destructuring in the parameter list.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-destructure.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-destructure.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/no-innerhtml.ts b/packages/eslint-plugin-solid/src/rules/no-innerhtml.ts index 7107e83..a283f71 100644 --- a/packages/eslint-plugin-solid/src/rules/no-innerhtml.ts +++ b/packages/eslint-plugin-solid/src/rules/no-innerhtml.ts @@ -22,7 +22,7 @@ export default createRule({ docs: { description: "Disallow usage of the innerHTML attribute, which can often lead to security vulnerabilities.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-innerhtml.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-innerhtml.md", }, fixable: "code", hasSuggestions: true, diff --git a/packages/eslint-plugin-solid/src/rules/no-proxy-apis.ts b/packages/eslint-plugin-solid/src/rules/no-proxy-apis.ts index e14823e..7c955f0 100644 --- a/packages/eslint-plugin-solid/src/rules/no-proxy-apis.ts +++ b/packages/eslint-plugin-solid/src/rules/no-proxy-apis.ts @@ -17,7 +17,7 @@ export default createRule({ docs: { description: "Disallow usage of APIs that use ES6 Proxies, only to target environments that don't support them.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-proxy-apis.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-proxy-apis.md", }, schema: [], messages: { diff --git a/packages/eslint-plugin-solid/src/rules/no-react-deps.ts b/packages/eslint-plugin-solid/src/rules/no-react-deps.ts index 7c46918..ee1069a 100644 --- a/packages/eslint-plugin-solid/src/rules/no-react-deps.ts +++ b/packages/eslint-plugin-solid/src/rules/no-react-deps.ts @@ -16,7 +16,7 @@ export default createRule({ type: "problem", docs: { description: "Disallow usage of dependency arrays in `createEffect` and `createMemo`.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-react-deps.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-deps.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/no-react-specific-props.ts b/packages/eslint-plugin-solid/src/rules/no-react-specific-props.ts index b9e2ff0..b90da13 100644 --- a/packages/eslint-plugin-solid/src/rules/no-react-specific-props.ts +++ b/packages/eslint-plugin-solid/src/rules/no-react-specific-props.ts @@ -14,7 +14,7 @@ export default createRule({ docs: { description: "Disallow usage of React-specific `className`/`htmlFor` props, which were deprecated in v1.4.0.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-react-specific-props.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-specific-props.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/no-unknown-namespaces.ts b/packages/eslint-plugin-solid/src/rules/no-unknown-namespaces.ts index 7bad7d3..df7d339 100644 --- a/packages/eslint-plugin-solid/src/rules/no-unknown-namespaces.ts +++ b/packages/eslint-plugin-solid/src/rules/no-unknown-namespaces.ts @@ -24,7 +24,7 @@ export default createRule({ docs: { description: "Enforce using only Solid-specific namespaced attribute names (i.e. `'on:'` in `
`).", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/no-unknown-namespaces.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-unknown-namespaces.md", }, hasSuggestions: true, schema: [ diff --git a/packages/eslint-plugin-solid/src/rules/prefer-classlist.ts b/packages/eslint-plugin-solid/src/rules/prefer-classlist.ts index 324deba..45458f4 100644 --- a/packages/eslint-plugin-solid/src/rules/prefer-classlist.ts +++ b/packages/eslint-plugin-solid/src/rules/prefer-classlist.ts @@ -20,7 +20,7 @@ export default createRule({ docs: { description: "Enforce using the classlist prop over importing a classnames helper. The classlist prop accepts an object `{ [class: string]: boolean }` just like classnames.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/prefer-classlist.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/prefer-classlist.md", }, fixable: "code", deprecated: true, diff --git a/packages/eslint-plugin-solid/src/rules/prefer-for.ts b/packages/eslint-plugin-solid/src/rules/prefer-for.ts index f2fcbf8..5add904 100644 --- a/packages/eslint-plugin-solid/src/rules/prefer-for.ts +++ b/packages/eslint-plugin-solid/src/rules/prefer-for.ts @@ -18,7 +18,7 @@ export default createRule({ docs: { description: "Enforce using Solid's `` component for mapping an array to JSX elements.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/prefer-for.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/prefer-for.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/prefer-show.ts b/packages/eslint-plugin-solid/src/rules/prefer-show.ts index 129b23d..b6b7900 100644 --- a/packages/eslint-plugin-solid/src/rules/prefer-show.ts +++ b/packages/eslint-plugin-solid/src/rules/prefer-show.ts @@ -20,7 +20,7 @@ export default createRule({ docs: { description: "Enforce using Solid's `` component for conditionally showing content. Solid's compiler covers this case, so it's a stylistic rule only.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/prefer-show.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/prefer-show.md", }, fixable: "code", schema: [], diff --git a/packages/eslint-plugin-solid/src/rules/reactivity.ts b/packages/eslint-plugin-solid/src/rules/reactivity.ts index 5162afa..db35fdf 100644 --- a/packages/eslint-plugin-solid/src/rules/reactivity.ts +++ b/packages/eslint-plugin-solid/src/rules/reactivity.ts @@ -237,7 +237,7 @@ export default createRule({ docs: { description: "Enforce that reactivity (props, signals, memos, etc.) is properly used, so changes in those values will be tracked and update the view as expected.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/reactivity.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/reactivity.md", }, schema: [ { diff --git a/packages/eslint-plugin-solid/src/rules/self-closing-comp.ts b/packages/eslint-plugin-solid/src/rules/self-closing-comp.ts index d93c89b..593356b 100644 --- a/packages/eslint-plugin-solid/src/rules/self-closing-comp.ts +++ b/packages/eslint-plugin-solid/src/rules/self-closing-comp.ts @@ -52,7 +52,7 @@ export default createRule({ type: "layout", docs: { description: "Disallow extra closing tags for components without children.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/self-closing-comp.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/self-closing-comp.md", }, fixable: "code", schema: [ diff --git a/packages/eslint-plugin-solid/src/rules/style-prop.ts b/packages/eslint-plugin-solid/src/rules/style-prop.ts index 50fbe44..c22581f 100644 --- a/packages/eslint-plugin-solid/src/rules/style-prop.ts +++ b/packages/eslint-plugin-solid/src/rules/style-prop.ts @@ -28,7 +28,7 @@ export default createRule({ description: "Require CSS properties in the `style` prop to be valid and kebab-cased (ex. 'font-size'), not camel-cased (ex. 'fontSize') like in React, " + "and that property values with dimensions are strings, not numbers with implicit 'px' units.", - url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/style-prop.md", + url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/style-prop.md", }, fixable: "code", schema: [