break: rename plugin (#138)

* break: rename plugin

* revamp unit tests

* update docs

* don't check in coverage report

* directly build TS

* update deps

* update readme

Author: christian-bromann

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -11,7 +11,7 @@ body:
           required: true
         - label: I agree to follow the [Code of Conduct](https://github.com/ionic-team/stencil/blob/main/CODE_OF_CONDUCT.md).
           required: true
-        - label: I have searched for [existing issues](https://github.com/stencil-community/stencil-eslint/issues) that already report this problem, without success.
+        - label: I have searched for [existing issues](https://github.com/stenciljs/eslint-plugin/issues) that already report this problem, without success.
           required: true
   - type: input
     attributes:

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -11,7 +11,7 @@ body:
           required: true
         - label: I agree to follow the [Code of Conduct](https://github.com/ionic-team/stencil/blob/main/CODE_OF_CONDUCT.md).
           required: true
-        - label: I have searched for [existing issues](https://github.com/stencil-community/stencil-eslint/issues) that already include this feature request, without success.
+        - label: I have searched for [existing issues](https://github.com/stenciljs/eslint-plugin/issues) that already include this feature request, without success.
           required: true
   - type: textarea
     attributes:

.gitignore

@@ -5,3 +5,4 @@ node_modules
 dist
 report
 *.tgz
+coverage

README.md

@@ -1,37 +1,17 @@
-# @stencil-community/eslint-plugin
+# @stencil/eslint-plugin
 
 ESLint rules specific to Stencil JS projects.
 
 ## Installation
 
-If you're using npm v7+, you only need to install this package. Its peer dependencies will be automatically installed.
-```bash
-npm i --save-dev @stencil-community/eslint-plugin
-```
-
-If you're using npm v6 or lower, you will need to install this package and its peer dependencies in your stencil project:
+Install this plugin in your project via:
 
 ```bash
-npm i --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react @stencil-community/eslint-plugin typescript
+npm i --save-dev @stencil/eslint-plugin
 ```
 
 ## Usage
 
-### Configuration (legacy: .eslintrc*)
-
-`.eslintrc.json` configuration file:
-
-```json
-{
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  },
-  "extends": [
-    "plugin:@stencil-community/recommended"
-  ]
-}
-```
-
 ### Configuration (new: eslint.config.*)
 
 The plugin exports 3 flat configs for use with eslint >= 9:
@@ -40,34 +20,33 @@ The plugin exports 3 flat configs for use with eslint >= 9:
 - flat.recommended
 - flat.strict
 
-
 ```js
-// eslint.config.js
-const stencilLint = require('@stencil-community/eslint-plugin');
+// eslint.config.mjs
+import stencil from '@stencil/eslint-plugin';
 
-module.exports = [
+export default [
   ...
-  stencilLint.configs.flat.recommended,
+  stencil.configs.flat.recommended,
   ...
 ];
 ```
 
 Alternatively:
 
 ```js
-// eslint.config.mjs
-import stencilLint from '@stencil-community/eslint-plugin';
+// eslint.config.js
+const stencil = require('@stencil/eslint-plugin');
 
-export default [
+module.exports = [
   ...
-  stencilLint.configs.flat.recommended,
+  stencil.configs.flat.recommended,
   ...
 ];
 ```
 
-
 By default, ESLint will ignore your `node_modules/` directory. Consider adding a `.eslintignore` file at the root of
 your project with any output target directories to avoid false positive errors from ESLint.
+
 ```
 # place any directories created by the Stencil compilation process here
 dist
@@ -76,104 +55,120 @@ www
 ```
 
 Lint all your project:
-```
+
+```sh
 npm run lint
 ```
 
+### Configuration (legacy: .eslintrc*)
+
+`.eslintrc.json` configuration file:
+
+```json
+{
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "extends": [
+    "plugin:stencil/recommended"
+  ]
+}
+```
+
 ## Supported Rules
 
-- [`@stencil-community/async-methods`](./docs/async-methods.md)
+- [`stencil/async-methods`](./docs/async-methods.md)
 
 This rule catches Stencil public methods that are not async.
 
-- [`@stencil-community/ban-default-true`](./docs/ban-default-true.md)
+- [`stencil/ban-default-true`](./docs/ban-default-true.md)
 
 This rule catches Stencil Props with a default value of `true`.
 
-- [`@stencil-community/ban-prefix`](./docs/ban-prefix.md)
+- [`stencil/ban-prefix`](./docs/ban-prefix.md)
 
 This rule catches Stencil Component banned tag name prefix.
 
-- [`@stencil-community/class-pattern`](./docs/class-pattern.md)
+- [`stencil/class-pattern`](./docs/class-pattern.md)
 
 This rule catches Stencil Component class name not matching configurable pattern.
 
-- [`@stencil-community/decorators-context`](./docs/decorators-context.md)
+- [`stencil/decorators-context`](./docs/decorators-context.md)
 
 This rule catches Stencil decorators in bad locations.
 
-- [`@stencil-community/decorators-style`](./docs/decorators-style.md)
+- [`stencil/decorators-style`](./docs/decorators-style.md)
 
 This rule catches Stencil decorators style usage.
 
-- [`@stencil-community/element-type`](./docs/element-type.md)
+- [`stencil/element-type`](./docs/element-type.md)
 
 This rule catches Stencil Element decorator have the correct type.
 
-- [`@stencil-community/host-data-deprecated`](./docs/host-data-deprecated.md)
+- [`stencil/host-data-deprecated`](./docs/host-data-deprecated.md)
 
 This rule catches Stencil method hostData.
 
-- [`@stencil-community/methods-must-be-public`](./docs/methods-must-be-public.md)
+- [`stencil/methods-must-be-public`](./docs/methods-must-be-public.md)
 
 This rule catches Stencil Methods marked as private or protected.
 
-- [`@stencil-community/no-unused-watch`](./docs/no-unused-watch.md)
+- [`stencil/no-unused-watch`](./docs/no-unused-watch.md)
 
 This rule catches Stencil Watchs with non existing Props or States.
 
-- [`@stencil-community/own-methods-must-be-private`](./docs/own-methods-must-be-private.md)
+- [`stencil/own-methods-must-be-private`](./docs/own-methods-must-be-private.md)
 
 This rule catches own class methods marked as public.
 
-- [`@stencil-community/own-props-must-be-private`](./docs/own-props-must-be-private.md)
+- [`stencil/own-props-must-be-private`](./docs/own-props-must-be-private.md)
 
 This rule catches own class properties marked as public.
 
-- [`@stencil-community/prefer-vdom-listener`](./docs/prefer-vdom-listener.md)
+- [`stencil/prefer-vdom-listener`](./docs/prefer-vdom-listener.md)
 
 This rule catches Stencil Listen with vdom events.
 
-- [`@stencil-community/props-must-be-public`](./docs/props-must-be-public.md)
+- [`stencil/props-must-be-public`](./docs/props-must-be-public.md)
 
 This rule catches Stencil Props marked as private or protected.
 
-- [`@stencil-community/props-must-be-readonly`](./docs/props-must-be-readonly.md)
+- [`stencil/props-must-be-readonly`](./docs/props-must-be-readonly.md)
 
 This rule catches Stencil Props marked as non readonly, excluding mutable ones.
 
-- [`@stencil-community/render-returns-host`](./docs/render-returns-host.md)
+- [`stencil/render-returns-host`](./docs/render-returns-host.md)
 
 This rule catches Stencil Render returning array instead of Host tag.
 
-- [`@stencil-community/required-jsdoc`](./docs/required-jsdoc.md)
+- [`stencil/required-jsdoc`](./docs/required-jsdoc.md)
 
 This rule catches Stencil Props, Methods and Events to define jsdoc.
 
-- [`@stencil-community/required-prefix`](./docs/required-prefix.md)
+- [`stencil/required-prefix`](./docs/required-prefix.md)
 
 This rule catches Stencil Component required tag name prefix.
 
-- [`@stencil-community/reserved-member-names`](./docs/reserved-member-names.md)
+- [`stencil/reserved-member-names`](./docs/reserved-member-names.md)
 
 This rule catches Stencil Prop names that share names of Global HTML Attributes.
 
-- [`@stencil-community/single-export`](./docs/single-export.md)
+- [`stencil/single-export`](./docs/single-export.md)
 
 This rule catches modules that expose more than just the Stencil Component itself.
 
-- [`@stencil-community/strict-mutable`](./docs/strict-mutable.md)
+- [`stencil/strict-mutable`](./docs/strict-mutable.md)
 
 This rule catches Stencil Prop marked as mutable but not changing value in code.
 
 ## Recommended rules
 
 ```json
 {
-  "@stencil-community/async-methods": "error",
-  "@stencil-community/ban-prefix": ["error", ["stencil", "stnl", "st"]],
-  "@stencil-community/decorators-context": "error",
-  "@stencil-community/decorators-style": [
+  "stencil/async-methods": "error",
+  "stencil/ban-prefix": ["error", ["stencil", "stnl", "st"]],
+  "stencil/decorators-context": "error",
+  "stencil/decorators-style": [
     "error", {
       "prop": "inline",
       "state": "inline",
@@ -183,20 +178,20 @@ This rule catches Stencil Prop marked as mutable but not changing value in code.
       "watch": "multiline",
       "listen": "multiline"
     }],
-  "@stencil-community/element-type": "error",
-  "@stencil-community/host-data-deprecated": "error",
-  "@stencil-community/methods-must-be-public": "error",
-  "@stencil-community/no-unused-watch": "error",
-  "@stencil-community/own-methods-must-be-private": "error",
-  "@stencil-community/own-props-must-be-private": "error",
-  "@stencil-community/prefer-vdom-listener": "error",
-  "@stencil-community/props-must-be-public": "error",
-  "@stencil-community/props-must-be-readonly": "error",
-  "@stencil-community/render-returns-host": "error",
-  "@stencil-community/required-jsdoc": "error",
-  "@stencil-community/reserved-member-names": "error",
-  "@stencil-community/single-export": "error",
-  "@stencil-community/strict-mutable": "error"
+  "stencil/element-type": "error",
+  "stencil/host-data-deprecated": "error",
+  "stencil/methods-must-be-public": "error",
+  "stencil/no-unused-watch": "error",
+  "stencil/own-methods-must-be-private": "error",
+  "stencil/own-props-must-be-private": "error",
+  "stencil/prefer-vdom-listener": "error",
+  "stencil/props-must-be-public": "error",
+  "stencil/props-must-be-readonly": "error",
+  "stencil/render-returns-host": "error",
+  "stencil/required-jsdoc": "error",
+  "stencil/reserved-member-names": "error",
+  "stencil/single-export": "error",
+  "stencil/strict-mutable": "error"
 }
 ```
 
@@ -211,4 +206,4 @@ All contributions welcome.
 
 ## License
 
-- [MIT](https://raw.githubusercontent.com/stencil-community/stencil/main/LICENSE)
+- [MIT](https://raw.githubusercontent.com/stenciljs/eslint-plugin/refs/heads/main/LICENSE.md)

docs/async-methods.md

@@ -9,7 +9,7 @@ No config is needed
 ## Usage
 
 ```json
-{ "@stencil-community/async-methods": "error" }
+{ "stencil/async-methods": "error" }
 ```
 
 > Fix included

docs/ban-default-true.md

@@ -9,7 +9,7 @@ No config is needed
 ## Usage
 
 ```json
-{ "@stencil-community/ban-default-true": "error" }
+{ "stencil/ban-default-true": "error" }
 ```
 
 

docs/ban-prefix.md

@@ -9,11 +9,11 @@ An array of `"string"`s which no Component `tag` will be allowed to use as a pre
 ### Config examples
 
 ```json
-{ "@stencil-community/ban-prefix": ["error", ["stencil"]] }
+{ "stencil/ban-prefix": ["error", ["stencil"]] }
 ```
 
 ```json
-{ "@stencil-community/ban-prefix": ["error", ["stencil", "st", "stnl"]] }
+{ "stencil/ban-prefix": ["error", ["stencil", "st", "stnl"]] }
 ```
 
 ## Schema

docs/class-pattern.md

@@ -12,7 +12,7 @@ An object containing:
 ### Config examples
 
 ```json
-{ "@stencil-community/class-pattern": ["error", { "pattern": "^(?!NoStart).*Component$", "ignoreCase": true }] }
+{ "stencil/class-pattern": ["error", { "pattern": "^(?!NoStart).*Component$", "ignoreCase": true }] }
 ```
 
 ## Schema

docs/decorators-context.md

@@ -9,5 +9,5 @@ No config is needed
 ## Usage
 
 ```json
-{ "@stencil-community/decorators-context": "error" }
+{ "stencil/decorators-context": "error" }
 ```

docs/decorators-style.md

@@ -18,7 +18,7 @@ If decorators are composed (multiple decorators for a single declaration), "mult
 ### Config examples
 
 ```json
-{ "@stencil-community/decorators-style": ["error", { "prop": "inline", "method": "multiline" }] }
+{ "stencil/decorators-style": ["error", { "prop": "inline", "method": "multiline" }] }
 ```
 
 ## Schema