@gitlab/eslint-plugin 9.4.0 → 11.0.0

package/CHANGELOG.md

@@ -1,3 +1,44 @@
+# [11.0.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v10.0.2...v11.0.0) (2022-02-22)
+
+
+### Features
+
+* remove unused rule vue-emit-events-with-two-args ([f9a4ddc](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/f9a4ddc967f163bd6aa9503b5c0cf86be28617dc))
+
+
+### BREAKING CHANGES
+
+* rule 'vue-emit-events-with-two-args' was removed.
+
+## [10.0.2](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v10.0.1...v10.0.2) (2022-01-12)
+
+
+### Bug Fixes
+
+* rule require-i18n-strings reports mailto false positive ([5b3397e](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/5b3397e929e6693be507e84742e1b35563ff87aa))
+
+## [10.0.1](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v10.0.0...v10.0.1) (2022-01-10)
+
+
+### Bug Fixes
+
+* **ci:** Generate GraphQL schema before running integration test ([d5e6d88](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/d5e6d88e5bb2e06d1ea923a95f7b1a425e5b09d0))
+
+# [10.0.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v9.4.0...v10.0.0) (2021-11-03)
+
+
+### Features
+
+* lint against missing translation namespaces ([db00d87](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/db00d87e3877fa0fe538775280a54fd820c89572))
+
+
+### BREAKING CHANGES
+
+* require-string-literal-i18n-helpers and
+vue-require-string-literal-i18n-helpers rules have been renamed to
+require-valid-i18n-helpers and vue-require-valid-i18n-helpers
+respectively.
+
 # [9.4.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v9.3.0...v9.4.0) (2021-09-21)
 
 

package/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+## Developer Certificate of Origin and License
+
+By contributing to GitLab B.V., you accept and agree to the following terms and
+conditions for your present and future contributions submitted to GitLab B.V.
+Except for the license granted herein to GitLab B.V. and recipients of software
+distributed by GitLab B.V., you reserve all right, title, and interest in and to
+your Contributions.
+
+All contributions are subject to the Developer Certificate of Origin and license set out at [docs.gitlab.com/ce/legal/developer_certificate_of_origin](https://docs.gitlab.com/ce/legal/developer_certificate_of_origin).
+
+_This notice should stay as the first item in the CONTRIBUTING.md file._
+
+## Code of conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be
+reported by emailing contact@gitlab.com.
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version 1.1.0,
+available at [https://contributor-covenant.org/version/1/1/0/](https://contributor-covenant.org/version/1/1/0/).

package/docs/development.md

@@ -18,3 +18,18 @@ Run `yarn createRule`, it will create:
 - `docs/rules/<name>.js` (documentation)
 - `lib/rules/<name>.js` (rule definition)
 - `tests/rules/<name>.js` (rule unit tests)
+
+## Testing
+
+Run `yarn test` to execute the test suite, the suite includes rule tests and util tests.
+Jest is used as the test runner for executing these tests.
+
+### Rule tests
+
+The [eslint ruletester](https://eslint.org/docs/developer-guide/unit-tests) is used to write tests for eslint rules, new tests should be added for new rules or updates to a rule.
+
+All the current rule tests are available in the `tests/lib/rules` directory.
+
+### Util tests
+
+These utilities are useful to simplify writing new tests and can be found in the `test/lib/utils` directory.

package/docs/rules/require-valid-i18n-helpers.md

@@ -0,0 +1,41 @@
+# @gitlab/require-valid-i18n-helpers
+
+This rule enforces valid usages of the translation helpers (`__`, `s__` and `n__`). It requires the
+following:
+
+- All helpers should be called with string-literal arguments to ensure the strings are properly
+  collected by the `gettext:regenerate` script.
+- `s__` requires a translation namespace to be provided.
+
+## Rule Details
+
+### Examples of **incorrect** code for this rule
+
+```js
+// Invalid argument types
+const label = __(LABEL);
+const description = __(getDescription());
+
+// Missing translation namespace
+const namespacedTranslation = s__('NamespacedTranslation');
+```
+
+### Examples of **correct** code for this rule
+
+```js
+// Valid argument type
+const label = __('Some label');
+
+// Valid translation namespace
+const namespacedTranslation = s__('Namespace|Translation');
+// or
+const otherNamespacedTranslation = s__('Namespace', 'Other translation');
+```
+
+## Options
+
+Nothing
+
+## Related rules
+
+- TBA

package/docs/rules/vue-require-valid-i18n-helpers.md

@@ -0,0 +1,42 @@
+# @gitlab/vue-require-valid-i18n-helpers
+
+This rule is like [require-valid-i18n-helpers](./require-valid-i18n-helpers.md) for Vue templates.
+
+## Rule Details
+
+### Examples of **incorrect** code for this rule
+
+```html
+<template>
+  <div>
+    <!-- Invalid argument types -->
+    {{ __(LABEL) }}
+    {{ __(getDescription()) }}
+
+    <!-- Missing translation namespace -->
+    {{ s__('NamespacedTranslation') }}
+  </div>
+</template>
+```
+
+### Examples of **correct** code for this rule
+
+```html
+<template>
+  <div>
+    <!-- Valid argument type -->
+    {{ __('Some label') }}
+
+    <!-- Valid translation namespace -->
+    {{ s__('Namespace|Translation') }}
+  </div>
+</template>
+```
+
+## Options
+
+Nothing
+
+## Related rules
+
+- TBA

package/docs/rules.md

@@ -7,12 +7,11 @@ Available rules:
 - [no-global-event-off](./rules/no-global-event-off.md): Throw an error when globally deregistering all event listeners.
 - [no-runtime-template-compiler](./rules/no-runtime-template-compiler.md): Disallow components which rely on a runtime template compiler.
 - [require-i18n-strings](./rules/require-i18n-strings.md): Detect a string which has been hard coded and requires externalization.
-- [require-string-literal-i18n-helpers](./rules/require-string-literal-i18n-helpers.md): Prevents translation helpers from being called with non-string-literal arguments.
-- [vue-emit-events-with-two-args](./rules/vue-emit-events-with-two-args.md): Throw an error when emit is called with more than two arguments.
+- [require-valid-i18n-helpers](./rules/require-valid-i18n-helpers.md): Enforces valid usage of translation helpers in JavaScript.
 - [vue-no-data-toggle](./rules/vue-no-data-toggle.md): Restrict the use of `data-toggle` bootstrap behaviors within Vue templates
 - [vue-no-new-non-primitive-in-template](./rules/vue-no-new-non-primitive-in-template.md): Prevents non-primitive values from being declared in templates
 - [vue-require-i18n-attribute-strings](./rules/vue-require-i18n-attribute-strings.md): Detect non externalized strings in vue `<template>` attributes
 - [vue-require-i18n-strings](./rules/vue-require-i18n-strings.md): enforce no bare strings in vue `<template>`
 - [vue-require-required-key](./rules/vue-require-required-key.md): Require the required key to be set
-- [vue-require-string-literal-i18n-helpers](./rules/vue-require-string-literal-i18n-helpers.md): Prevents translation helpers from being called with non-string-literal arguments in Vue templates.
+- [vue-require-valid-i18n-helpers](./rules/vue-require-valid-i18n-helpers.md): Enforces valid usage of translation helpers in Vue templates.
 - [vue-slot-name-casing](./rules/vue-slot-name-casing.md): enforce specific casing for slot naming style in template