Fixed missing namespace in recommended config. (#71)

ota-meshi · web-flow · commit 33ff31b2f43e · 2020-07-12T22:44:32.000+09:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -37,4 +37,5 @@ jobs:
 
       # run tests!
       - run: yarn lint
-      - run: yarn test
+      - run: yarn test
+      - run: yarn test:integrations
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -18,8 +18,8 @@ module.exports = {
     ['meta', { name: 'theme-color', content: '#3eaf7c' }]
   ],
   themeConfig: {
-    repo: 'kazupon/eslint-plugin-vue-i18n',
-    docsRepo: 'kazupon/eslint-plugin-vue-i18n',
+    repo: 'intlify/eslint-plugin-vue-i18n',
+    docsRepo: 'intlify/eslint-plugin-vue-i18n',
     docsDir: 'docs',
     docsBranch: 'master',
     editLinks: true,
@@ -33,7 +33,7 @@ module.exports = {
       link: 'https://www.patreon.com/kazupon'
     }, {
       text: 'Release Notes',
-      link: 'https://github.com/kazupon/eslint-plugin-vue-i18n/releases'
+      link: 'https://github.com/intlify/eslint-plugin-vue-i18n/releases'
     }],
     sidebar: {
       '/': [
diff --git a/docs/rules/README.md b/docs/rules/README.md
@@ -1,21 +1,21 @@
 # Available Rules
 
-- :star: mark: the rule which is enabled by `vue-i18n/recommended` preset.
+- :star: mark: the rule which is enabled by `plugin:@intlify/vue-i18n/recommended` preset.
 - :black_nib: mark: the rule which is fixable by `eslint --fix` command.
 
 ## Recommended
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [vue-i18n/<wbr>no-html-messages](./no-html-messages.html) | disallow use HTML localization messages | :star: |
-| [vue-i18n/<wbr>no-missing-keys](./no-missing-keys.html) | disallow missing locale message key at localization methods | :star: |
-| [vue-i18n/<wbr>no-raw-text](./no-raw-text.html) | disallow to string literal in template or JSX | :star: |
-| [vue-i18n/<wbr>no-v-html](./no-v-html.html) | disallow use of localization methods on v-html to prevent XSS attack | :star: |
+| [@intlify/vue-i18n/<wbr>no-html-messages](./no-html-messages.html) | disallow use HTML localization messages | :star: |
+| [@intlify/vue-i18n/<wbr>no-missing-keys](./no-missing-keys.html) | disallow missing locale message key at localization methods | :star: |
+| [@intlify/vue-i18n/<wbr>no-raw-text](./no-raw-text.html) | disallow to string literal in template or JSX | :star: |
+| [@intlify/vue-i18n/<wbr>no-v-html](./no-v-html.html) | disallow use of localization methods on v-html to prevent XSS attack | :star: |
 
 ## Best Practices
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [vue-i18n/<wbr>no-dynamic-keys](./no-dynamic-keys.html) | disallow localization dynamic keys at localization methods |  |
-| [vue-i18n/<wbr>no-unused-keys](./no-unused-keys.html) | disallow unused localization keys |  |
+| [@intlify/vue-i18n/<wbr>no-dynamic-keys](./no-dynamic-keys.html) | disallow localization dynamic keys at localization methods |  |
+| [@intlify/vue-i18n/<wbr>no-unused-keys](./no-unused-keys.html) | disallow unused localization keys |  |
 
diff --git a/docs/rules/keys-order.md b/docs/rules/keys-order.md
@@ -1,4 +1,4 @@
-# vue-i18n/keys-order
+# @intlify/vue-i18n/keys-order
 
 > enforce order of localization keys
 
@@ -37,7 +37,7 @@ This rule is useful to provide browsability of localization keys.
 
 ```json
 {
-  "vue-i18n/keys-order": ["error", {
+  "@intlify/vue-i18n/keys-order": ["error", {
     "order": "desc"
   }]
 }
diff --git a/docs/rules/no-dynamic-keys.md b/docs/rules/no-dynamic-keys.md
@@ -1,4 +1,4 @@
-# vue-i18n/no-dynamic-keys
+# @intlify/vue-i18n/no-dynamic-keys
 
 > disallow localization dynamic keys at localization methods
 
diff --git a/docs/rules/no-html-messages.md b/docs/rules/no-html-messages.md
@@ -1,8 +1,8 @@
-# vue-i18n/no-html-messages
+# @intlify/vue-i18n/no-html-messages
 
 > disallow use HTML localization messages
 
-- :star: The `"extends": "plugin:vue-i18n/recommended"` property in a configuration file enables this rule.
+- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` property in a configuration file enables this rule.
 
 This rule reports in order to reduce the risk of injecting potentially unsafe localization message into the browser leading to supply-chain attack or XSS attack.
 
diff --git a/docs/rules/no-missing-keys.md b/docs/rules/no-missing-keys.md
@@ -1,8 +1,8 @@
-# vue-i18n/no-missing-keys
+# @intlify/vue-i18n/no-missing-keys
 
 > disallow missing locale message key at localization methods
 
-- :star: The `"extends": "plugin:vue-i18n/recommended"` property in a configuration file enables this rule.
+- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` property in a configuration file enables this rule.
 
 This rule warns locale message key missing if the key does not exist in locale messages.
 
diff --git a/docs/rules/no-raw-text.md b/docs/rules/no-raw-text.md
@@ -1,8 +1,8 @@
-# vue-i18n/no-raw-text
+# @intlify/vue-i18n/no-raw-text
 
 > disallow to string literal in template or JSX
 
-- :star: The `"extends": "plugin:vue-i18n/recommended"` property in a configuration file enables this rule.
+- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` property in a configuration file enables this rule.
 
 This rule warns the usage of string literal.
 
@@ -70,7 +70,7 @@ export default {
 
 ```json
 {
-  "vue-i18n/no-raw-text": ["error", {
+  "@intlify/vue-i18n/no-raw-text": ["error", {
     "ignoreNodes": ["md-icon", "v-icon"],
     "ignorePattern": "^[-#:()&]+$",
     "ignoreText": ["EUR", "HKD", "USD"]
diff --git a/docs/rules/no-unused-keys.md b/docs/rules/no-unused-keys.md
@@ -1,4 +1,4 @@
-# vue-i18n/no-unused-keys
+# @intlify/vue-i18n/no-unused-keys
 
 > disallow unused localization keys
 
@@ -80,7 +80,7 @@ i18n.t('hi')
 
 ```json
 {
-  "vue-i18n/no-unused-keys": ["error", {
+  "@intlify/vue-i18n/no-unused-keys": ["error", {
     "src": ["./src"],
     "extensions": [".js", ".vue"]
   }]
diff --git a/docs/rules/no-v-html.md b/docs/rules/no-v-html.md
@@ -1,8 +1,8 @@
-# vue-i18n/no-v-html
+# @intlify/vue-i18n/no-v-html
 
 > disallow use of localization methods on v-html to prevent XSS attack
 
-- :star: The `"extends": "plugin:vue-i18n/recommended"` property in a configuration file enables this rule.
+- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` property in a configuration file enables this rule.
 
 This rule reports all uses of localization methods on `v-html` directive in order to reduce the risk of injecting potentially unsafe / unescaped html into the browser leading to Cross-Site Scripting (XSS) attacks.
 
diff --git a/docs/rules/valid-message-syntax.md b/docs/rules/valid-message-syntax.md
@@ -1,8 +1,8 @@
-# vue-i18n/valid-message-syntax
+# @intlify/vue-i18n/valid-message-syntax
 
 > disallow invalid message syntax
 
-- :star: The `"extends": "plugin:vue-i18n/recommended"` property in a configuration file enables this rule.
+- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` property in a configuration file enables this rule.
 
 This rule warns invalid message syntax.
 
diff --git a/docs/started.md b/docs/started.md
@@ -23,12 +23,12 @@ For example:
 module.export = {
   extends: [
     'eslint:recommended',
-    'plugin:vue-i18n/recommended'
+    'plugin:@intlify/vue-i18n/recommended'
   ],
   rules: {
     // Optional.
-    'vue-i18n/no-dynamic-keys': 'error',
-    'vue-i18n/no-unused-keys': ['error', {
+    '@intlify/vue-i18n/no-dynamic-keys': 'error',
+    '@intlify/vue-i18n/no-unused-keys': ['error', {
       extensions: ['.js', '.vue']
     }]
   },
@@ -73,7 +73,7 @@ The most rules of `eslint-plugin-vue-i18n` require `vue-eslint-parser` to check
 
 Make sure you have one of the following settings in your **.eslintrc**:
 
-- `"extends": ["plugin:vue-i18n/recommended"]`
+- `"extends": ["plugin:@intlify/vue-i18n/recommended"]`
 
 If you already use other parser (e.g. `"parser": "babel-eslint"`), please move it into `parserOptions`, so it doesn't collide with the `vue-eslint-parser` used by this plugin's configuration:
 
diff --git a/lib/configs/recommended.js b/lib/configs/recommended.js
@@ -14,11 +14,11 @@ module.exports = {
     browser: true,
     es6: true
   },
-  plugins: ['vue-i18n'],
+  plugins: ['@intlify/vue-i18n'],
   rules: {
-    'vue-i18n/no-html-messages': 'warn',
-    'vue-i18n/no-missing-keys': 'warn',
-    'vue-i18n/no-raw-text': 'warn',
-    'vue-i18n/no-v-html': 'warn'
+    '@intlify/vue-i18n/no-html-messages': 'warn',
+    '@intlify/vue-i18n/no-missing-keys': 'warn',
+    '@intlify/vue-i18n/no-raw-text': 'warn',
+    '@intlify/vue-i18n/no-v-html': 'warn'
   }
 }
diff --git a/lib/processors/json.js b/lib/processors/json.js
@@ -19,7 +19,7 @@ module.exports = {
     delete localeMessageFiles[filename]
     return [...errors.filter(
       error => !error.ruleId ||
-        (error.ruleId === 'vue-i18n/no-unused-keys' || error.ruleId === 'vue-i18n/no-html-messages')
+        (error.ruleId === '@intlify/vue-i18n/no-unused-keys' || error.ruleId === '@intlify/vue-i18n/no-html-messages')
     )]
   },
 
diff --git a/package.json b/package.json
@@ -83,6 +83,7 @@
     "release:prepare": "shipjs prepare",
     "release:trigger": "shipjs trigger",
     "test": "mocha ./tests/**/*.js",
-    "test:coverage": "nyc mocha ./tests/**/*.js"
+    "test:coverage": "nyc mocha ./tests/**/*.js",
+    "test:integrations": "mocha ./tests-integrations/*.js --timeout 60000"
   }
 }
diff --git a/scripts/lib/rules.js b/scripts/lib/rules.js
@@ -13,7 +13,7 @@ const rules = readdirSync(resolve(__dirname, '../../lib/rules'))
   .map(name => {
     const meta = require(`../../lib/rules/${name}`).meta
     return {
-      id: `vue-i18n/${name}`,
+      id: `@intlify/vue-i18n/${name}`,
       name,
       category: String(meta.docs.category),
       description: String(meta.docs.description),
diff --git a/scripts/update-docs-headers.js b/scripts/update-docs-headers.js
@@ -26,7 +26,7 @@ for (const rule of rules) {
     )
   } else if (rule.recommended) {
     headerLines.push(
-      '- :star: The `"extends": "plugin:vue-i18n/recommended"` property in a configuration file enables this rule.'
+      '- :star: The `"extends": "plugin:@intlify/vue-i18n/recommended"` property in a configuration file enables this rule.'
     )
   }
 
diff --git a/scripts/update-docs-index.js b/scripts/update-docs-index.js
@@ -11,7 +11,7 @@ const { withCategories } = require('./lib/rules')
 
 function toTableRow (rule) {
   const mark = `${rule.recommended ? ':star:' : ''}${rule.fixable ? ':black_nib:' : ''}`
-  const link = `[vue-i18n/<wbr>${rule.name}](./${rule.name}.html)`
+  const link = `[@intlify/vue-i18n/<wbr>${rule.name}](./${rule.name}.html)`
   const description = rule.description || '(no description)'
   return `| ${link} | ${description} | ${mark} |`
 }
@@ -28,7 +28,7 @@ ${rules.map(toTableRow).join('\n')}
 writeFileSync(
   resolve(__dirname, '../docs/rules/README.md'), `# Available Rules
 
-- :star: mark: the rule which is enabled by \`vue-i18n/recommended\` preset.
+- :star: mark: the rule which is enabled by \`plugin:@intlify/vue-i18n/recommended\` preset.
 - :black_nib: mark: the rule which is fixable by \`eslint --fix\` command.
 
 ${withCategories.map(toCategorySection).join('\n')}
diff --git a/scripts/update-recommended-rules.js b/scripts/update-recommended-rules.js
@@ -29,7 +29,7 @@ module.exports = {
     browser: true,
     es6: true
   },
-  plugins: ['vue-i18n'],
+  plugins: ['@intlify/vue-i18n'],
   rules: {
     ${rules.filter(rule => rule.recommended)
     .map(rule => `'${rule.id}': 'warn',`)
diff --git a/tests-integrations/config-recommended.js b/tests-integrations/config-recommended.js
@@ -0,0 +1,35 @@
+'use strict'
+
+const cp = require('child_process')
+const path = require('path')
+const assert = require('assert')
+
+const TEST_CWD = path.join(__dirname, 'config-recommended')
+
+describe('Integration with "plugin:@intlify/vue-i18n/recommended"', () => {
+  let originalCwd
+
+  before(() => {
+    originalCwd = process.cwd()
+    process.chdir(TEST_CWD)
+    cp.execSync('npm i', { stdio: 'inherit' })
+  })
+  after(() => {
+    process.chdir(originalCwd)
+  })
+
+  it('should work with shareable config', () => {
+    const CLIEngine = require('./config-recommended/node_modules/eslint').CLIEngine
+    const engine = new CLIEngine({
+      cwd: TEST_CWD,
+      extensions: ['.js', '.vue', '.json']
+    })
+    const result = engine.executeOnFiles(['./src'])
+    const enJson = result.results.find(r => path.basename(r.filePath) === 'en.json')
+    assert.strictEqual(enJson.messages.length, 1)
+    assert.strictEqual(enJson.messages[0].ruleId, '@intlify/vue-i18n/no-html-messages')
+    const aVue = result.results.find(r => path.basename(r.filePath) === 'a.vue')
+    assert.strictEqual(aVue.messages.length, 1)
+    assert.strictEqual(aVue.messages[0].ruleId, '@intlify/vue-i18n/no-missing-keys')
+  })
+})
diff --git a/tests-integrations/config-recommended/.eslintrc.js b/tests-integrations/config-recommended/.eslintrc.js
@@ -0,0 +1,13 @@
+'use strict'
+
+module.exports = {
+  root: true,
+  extends: [
+    'plugin:@intlify/vue-i18n/recommended'
+  ],
+  settings: {
+    'vue-i18n': {
+      localeDir: `./src/resources/*.json`
+    }
+  }
+}
diff --git a/tests-integrations/config-recommended/.npmrc b/tests-integrations/config-recommended/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/tests-integrations/config-recommended/package-lock.json b/tests-integrations/config-recommended/package-lock.json
diff --git a/tests-integrations/config-recommended/package.json b/tests-integrations/config-recommended/package.json
diff --git a/tests-integrations/config-recommended/src/a.vue b/tests-integrations/config-recommended/src/a.vue
diff --git a/tests-integrations/config-recommended/src/resources/en.json b/tests-integrations/config-recommended/src/resources/en.json
diff --git a/tests/lib/rules/no-html-messages.js b/tests/lib/rules/no-html-messages.js
diff --git a/tests/lib/rules/no-unused-keys.js b/tests/lib/rules/no-unused-keys.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# vue-i18n/keys-order`
	`1`	`+# @intlify/vue-i18n/keys-order`
`2`	`2`
`3`	`3`	`> enforce order of localization keys`
`4`	`4`
`@@ -37,7 +37,7 @@ This rule is useful to provide browsability of localization keys.`
`37`	`37`
`38`	`38`	```json
`39`	`39`	`{`
`40`		`- "vue-i18n/keys-order": ["error", {`
	`40`	`+ "@intlify/vue-i18n/keys-order": ["error", {`
`41`	`41`	`"order": "desc"`
`42`	`42`	`}]`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# vue-i18n/no-dynamic-keys`
	`1`	`+# @intlify/vue-i18n/no-dynamic-keys`
`2`	`2`
`3`	`3`	`> disallow localization dynamic keys at localization methods`
`4`	`4`