From 44a18e57fd43a554efdb8d721bdafe8a46579a97 Mon Sep 17 00:00:00 2001 From: akerstrom Date: Fri, 8 Sep 2017 11:55:21 +0200 Subject: [PATCH] chore: add generator for TypeScript linting --- generators/linting-ts/README.md | 15 +++++ generators/linting-ts/index.js | 55 +++++++++++++++++++ generators/linting-ts/templates/tsconfig.json | 53 ++++++++++++++++++ generators/linting-ts/templates/tslint.json | 4 ++ test/linting-ts-test.js | 38 +++++++++++++ 5 files changed, 165 insertions(+) create mode 100644 generators/linting-ts/README.md create mode 100644 generators/linting-ts/index.js create mode 100644 generators/linting-ts/templates/tsconfig.json create mode 100644 generators/linting-ts/templates/tslint.json create mode 100644 test/linting-ts-test.js diff --git a/generators/linting-ts/README.md b/generators/linting-ts/README.md new file mode 100644 index 0000000..a12cac7 --- /dev/null +++ b/generators/linting-ts/README.md @@ -0,0 +1,15 @@ +# linting + +Installs Type Script linter dependencies and creates lint configuration files. + +## Usage + +Run generator from root of the project that needs linting. + +``` +$ yo springworks:linting-ts +``` + +## Result + +NPM modules will be installed and `tslint` created in `.` and `./test` dir. diff --git a/generators/linting-ts/index.js b/generators/linting-ts/index.js new file mode 100644 index 0000000..332b54a --- /dev/null +++ b/generators/linting-ts/index.js @@ -0,0 +1,55 @@ +'use strict'; + +const path = require('path'); +const generators = require('yeoman-generator'); +const package_updater = require('../../lib/package-updater'); + +module.exports = generators.Base.extend({ + + constructor: function() { + generators.Base.apply(this, arguments); + }, + + initializing: function() { + const welcomeMessage = [ + '\nSetting up linting for Type Script\n', + ]; + this.log(welcomeMessage.join('')); + }, + + writing: { + + linterConfigs: function() { + this.copy('tslint.json', 'tslint.json'); + this.copy('tsconfig.json', 'tsconfig.json'); + }, + + updatePackageFile: function() { + const pkg_path = path.join(process.cwd(), 'package.json'); + const changes = { + scripts: { + lint: 'tslint -p ./tsconfig.json', + }, + }; + package_updater.updatePackageFile({ + pkg_path: pkg_path, + changes: changes, + generator: this, + }); + }, + + }, + + install: { + + installDependencies: function() { + const dependencies = [ + 'tslint', + '@springworks/tslint-config', + ]; + this.npmInstall(dependencies, { saveDev: true }); + }, + + }, + +}); diff --git a/generators/linting-ts/templates/tsconfig.json b/generators/linting-ts/templates/tsconfig.json new file mode 100644 index 0000000..ef4429c --- /dev/null +++ b/generators/linting-ts/templates/tsconfig.json @@ -0,0 +1,53 @@ +{ + "compilerOptions": { + /* Basic Options */ + "target": "es2017", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd' or 'es2015'. */ + "lib": ["ES2015"], /* 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. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./build", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "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. */ + // "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. */ + + /* 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": [], /* 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. */ + + /* 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. */ + } +} diff --git a/generators/linting-ts/templates/tslint.json b/generators/linting-ts/templates/tslint.json new file mode 100644 index 0000000..ad15fa3 --- /dev/null +++ b/generators/linting-ts/templates/tslint.json @@ -0,0 +1,4 @@ +{ + "extends": "@springworks/tslint-config", + "rules": {} +} diff --git a/test/linting-ts-test.js b/test/linting-ts-test.js new file mode 100644 index 0000000..c4f92f3 --- /dev/null +++ b/test/linting-ts-test.js @@ -0,0 +1,38 @@ +'use strict'; + +const path = require('path'); +const assert = require('yeoman-assert'); +const helpers = require('yeoman-test'); +const package_updater = require('../lib/package-updater'); +const autorestoredSandbox = require('@springworks/test-harness/autorestored-sandbox'); + +describe('test/linting-ts-test.js', () => { + const sinon_sandbox = autorestoredSandbox(); + + beforeEach(() => { + sinon_sandbox.stub(package_updater, 'updatePackageFile').returns(); + }); + + beforeEach(done => { + helpers.run(path.join(__dirname, '..', 'generators', 'linting-ts')) + .withOptions({ + 'skip-install': true, + }) + .withPrompts() + .on('end', done); + }); + + it('should copy tslint to root dir', () => { + assert.file('tslint.json'); + }); + + it('should add "lint" script to package file', () => { + const call_args = package_updater.updatePackageFile.firstCall.args; + call_args[0].changes.should.eql({ + scripts: { + lint: 'tslint -p ./tsconfig.json', + }, + }); + }); + +});