From 40c54b162a20d6a2502d56970487137843da6b1c Mon Sep 17 00:00:00 2001 From: edvardchen <> Date: Wed, 10 Jul 2019 21:07:38 +0800 Subject: [PATCH] feat: skip literal with LiteralType --- lib/rules/no-literal-string.js | 17 ++++++++ tests/lib/rules/no-literal-string.js | 25 +++++------ tests/lib/rules/tsconfig.json | 65 ++++++++++++++++++++++++++++ 3 files changed, 94 insertions(+), 13 deletions(-) create mode 100644 tests/lib/rules/tsconfig.json diff --git a/lib/rules/no-literal-string.js b/lib/rules/no-literal-string.js index 8292f1d..5c2c1ad 100644 --- a/lib/rules/no-literal-string.js +++ b/lib/rules/no-literal-string.js @@ -5,6 +5,7 @@ 'use strict'; const { isUpperCase } = require('../helper'); +// const { TypeFlags, SyntaxKind } = require('typescript'); //------------------------------------------------------------------------------ // Rule Definition @@ -174,6 +175,22 @@ module.exports = { // dont care whether if this is computed or not if (isUpperCase(parent.key.name || parent.key.value)) visited.push(node); + + // + // TYPESCRIPT PART + // + + const { esTreeNodeToTSNodeMap, program } = parserServices; + if (program && esTreeNodeToTSNodeMap) { + const checker = program.getTypeChecker(); + const tsNode = esTreeNodeToTSNodeMap.get(node); + const typeObj = checker.getTypeAtLocation(tsNode.parent); + + if (typeObj.isStringLiteral()) { + visited.push(node); + } + // • • • • • + } }, 'CallExpression Literal'(node) { diff --git a/tests/lib/rules/no-literal-string.js b/tests/lib/rules/no-literal-string.js index d843eb6..31a1cc8 100644 --- a/tests/lib/rules/no-literal-string.js +++ b/tests/lib/rules/no-literal-string.js @@ -9,7 +9,8 @@ //------------------------------------------------------------------------------ var rule = require('../../../lib/rules/no-literal-string'), - RuleTester = require('eslint').RuleTester; + RuleTester = require('eslint').RuleTester, + path = require('path'); //------------------------------------------------------------------------------ // Tests @@ -100,27 +101,25 @@ const tsTester = new RuleTester({ parser: '@typescript-eslint/parser', parserOptions: { sourceType: 'module', - ecmaFeatures: { - jsx: true - } + project: path.resolve(__dirname, 'tsconfig.json') } }); tsTester.run('no-literal-string', rule, { valid: [ - { code: '
' }, - { - code: "var a: Element['nodeName']" - }, - { - code: "var a: Omit" - } + { code: '
', filename: 'a.tsx' }, + { code: "var a: Element['nodeName']" }, + { code: "var a: Omit" }, + { code: "type T = {name: 'b'} ; var a: T = {name: 'b'}" } ], invalid: [ { - code: `()`, + code: ``, + filename: 'a.tsx', errors - } + }, + + { code: "var a: {type: string} = {type: 'bb'}", errors } ] }); // ──────────────────────────────────────────────────────────────────────────────── diff --git a/tests/lib/rules/tsconfig.json b/tests/lib/rules/tsconfig.json new file mode 100644 index 0000000..74212d6 --- /dev/null +++ b/tests/lib/rules/tsconfig.json @@ -0,0 +1,65 @@ +{ + "compilerOptions": { + /* Basic Options */ + "target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */, + "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */, + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + "jsx": "preserve" /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */, + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + "sourceMap": true /* Generates corresponding '.map' file. */, + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + "preserveWatchOutput": true, + "allowUnreachableCode": false, + "resolveJsonModule": true, + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + "types": [ + "node" + ] /* Type declaration files to be included in compilation. */, + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + } +}