feature(@putout/processor-typescript) add

coderaiser · coderaiser · commit 270da98e296e · 2021-03-18T17:17:56.000+02:00
diff --git a/README.md b/README.md
@@ -113,8 +113,8 @@ Here is a list of built-int processors:
 | [`@putout/processor-markdown`](/packages/processor-markdown) | [![npm](https://img.shields.io/npm/v/@putout/processor-markdown.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-markdown) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-markdown)](https://david-dm.org/coderaiser/putout?path=packages/processor-markdown) |
 | [`@putout/processor-ignore`](/packages/processor-ignore) | [![npm](https://img.shields.io/npm/v/@putout/processor-ignore.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-ignore) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-ignore)](https://david-dm.org/coderaiser/putout?path=packages/processor-ignore) |
 | [`@putout/processor-yaml`](/packages/processor-yaml) | [![npm](https://img.shields.io/npm/v/@putout/processor-yaml.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-yaml) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-yaml)](https://david-dm.org/coderaiser/putout?path=packages/processor-yaml) |
-| [`@putout/processor-css`](/packages/processor-css) | [![npm](https://img.shields.io/npm/v/@putout/processor-css.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-css) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-css)](https://david-dm.org/coderaiser/putout?path=packages/processor-css) |
-| [`@putout/processor-html`](/packages/processor-html) | [![npm](https://img.shields.io/npm/v/@putout/processor-html.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-html) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-html)](https://david-dm.org/coderaiser/putout?path=packages/processor-html) |
+| [`@putout/processor-css`](/packages/processor-css) | [![npm](https://img.shields.io/npm/v/@putout/processor-css.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-css) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-css)](https://david-dm.org/coderaiser/putout?path=packages/processor-css) || [`@putout/processor-html`](/packages/processor-html) | [![npm](https://img.shields.io/npm/v/@putout/processor-html.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-html) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-html)](https://david-dm.org/coderaiser/putout?path=packages/processor-html) |
+| [`@putout/processor-typescript`](/packages/processor-typescript) | [![npm](https://img.shields.io/npm/v/@putout/processor-typescript.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/processor-typescript) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/processor-typescript)](https://david-dm.org/coderaiser/putout?path=packages/processor-typescript) |
 
 ## API
 
diff --git a/packages/processor-typescript/.eslintrc.json b/packages/processor-typescript/.eslintrc.json
@@ -0,0 +1,16 @@
+{
+    "overrides": [{
+        "files": "test/*.js",
+        "rules": {
+            "node/no-missing-require": "off"
+        }
+    }],
+    "extends": [
+        "plugin:node/recommended",
+        "plugin:putout/recommended"
+    ],
+    "plugins": [
+        "putout",
+        "node"
+    ]
+}
diff --git a/packages/processor-typescript/.gitignore b/packages/processor-typescript/.gitignore
@@ -0,0 +1,5 @@
+node_modules
+*.swp
+yarn-error.log
+
+coverage
diff --git a/packages/processor-typescript/.madrun.mjs b/packages/processor-typescript/.madrun.mjs
@@ -0,0 +1,13 @@
+import {run} from 'madrun';
+
+export default {
+    'test': () => `tape 'lib/**/*.spec.js' 'test/*.js'`,
+    'watch:test': async () => `nodemon -w lib -w test -x ${await run('test')}`,
+    'lint': () => `putout .`,
+    'fresh:lint': () => run('lint', '--fresh'),
+    'lint:fresh': () => run('lint', '--fresh'),
+    'fix:lint': () => run('lint', '--fix'),
+    'coverage': async () => `c8 ${await run('test')}`,
+    'report': () => 'c8 report --reporter=lcov',
+};
+
diff --git a/packages/processor-typescript/.npmignore b/packages/processor-typescript/.npmignore
@@ -0,0 +1,7 @@
+.*
+*.spec.js
+test
+yarn-error.log
+fixture
+
+coverage
diff --git a/packages/processor-typescript/.nycrc.json b/packages/processor-typescript/.nycrc.json
@@ -0,0 +1,14 @@
+{
+    "check-coverage": true,
+    "all": true,
+    "exclude": [
+        "**/*.spec.*",
+        "**/fixture",
+        "test",
+        ".*.*"
+    ],
+    "branches": 100,
+    "lines": 100,
+    "functions": 100,
+    "statements": 100
+}
diff --git a/packages/processor-typescript/.putout.json b/packages/processor-typescript/.putout.json
@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "putout": "on"
+    }
+}
diff --git a/packages/processor-typescript/LICENSE b/packages/processor-typescript/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/processor-typescript/README.md b/packages/processor-typescript/README.md
@@ -0,0 +1,30 @@
+# @putout/processor-typescript [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+
+[NPMIMGURL]:                https://img.shields.io/npm/v/@putout/processor-typescript.svg?style=flat&longCache=true
+[NPMURL]:                   https://npmjs.org/package/@putout/processor-typescript "npm"
+
+[DependencyStatusURL]:      https://david-dm.org/coderaiser/putout?path=packages/processor-typescript
+[DependencyStatusIMGURL]:   https://david-dm.org/coderaiser/putout.svg?path=packages/processor-typescript
+
+`putout` processor adds support of type check for `typescript` files.
+
+## Install
+
+```
+npm i @putout/processor-typescript -D
+```
+
+## Usage
+
+```json
+{
+    "processors": [
+        "typescript"
+    ]
+}
+```
+
+## License
+
+MIT
+
diff --git a/packages/processor-typescript/lib/typescript.js b/packages/processor-typescript/lib/typescript.js
@@ -0,0 +1,30 @@
+'use strict';
+
+module.exports.files = [
+    '*.ts',
+    '*.tsx',
+];
+
+module.exports.process = (rawSource) => {
+    const {Project} = require('ts-morph');
+    const project = new Project();
+    
+    const sourceFile = project.createSourceFile('__putout_processor_typescript.ts', rawSource);
+    const diagnostics = sourceFile.getPreEmitDiagnostics();
+    
+    const places = diagnostics.map(toPlace);
+    
+    return [rawSource, places];
+};
+
+function toPlace(diagnostic) {
+    return {
+        rule: 'type-check (typescript)',
+        message: diagnostic.getMessageText(),
+        position: {
+            line: diagnostic.getLineNumber(),
+            column: 1,
+        },
+    };
+}
+
diff --git a/packages/processor-typescript/package.json b/packages/processor-typescript/package.json
@@ -0,0 +1,55 @@
+{
+  "name": "@putout/processor-typescript",
+  "version": "1.0.0",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "putout processor adds ability to typecheck typescript",
+  "homepage": "http://github.com/coderaiser/putout",
+  "main": "lib/typescript.js",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report"
+  },
+  "dependencies": {
+    "ts-morph": "^10.0.1"
+  },
+  "keywords": [
+    "putout",
+    "putout-processor",
+    "typescript"
+  ],
+  "devDependencies": {
+    "@putout/engine-processor": "*",
+    "c8": "^7.5.0",
+    "eslint": "^7.0.0",
+    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-putout": "^7.0.0",
+    "lerna": "^4.0.0",
+    "madrun": "^8.0.1",
+    "nodemon": "^2.0.1",
+    "putout": "*",
+    "supertape": "^5.0.0"
+  },
+  "peerDependencies": {
+    "putout": ">=11"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=12"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/packages/processor-typescript/test/fixture/typescript.ts b/packages/processor-typescript/test/fixture/typescript.ts
@@ -0,0 +1,2 @@
+const fn = (a): null => 0;
+
diff --git a/packages/processor-typescript/test/typescript.js b/packages/processor-typescript/test/typescript.js
@@ -0,0 +1,61 @@
+'use strict';
+
+const {join} = require('path');
+const {readFile} = require('fs/promises');
+
+const test = require('supertape');
+const {runProcessors} = require('@putout/engine-processor');
+const processFile = require('putout/process-file');
+
+const process = getProcess({
+    extension: 'ts',
+    processors: [
+        'typescript',
+    ],
+});
+
+test('putout: processor: typescript', async (t) => {
+    const {places} = await process('typescript');
+    const expected = [{
+        message: 'Type \'0\' is not assignable to type \'null\'.',
+        position: {
+            column: 1,
+            line: 1,
+        },
+        rule: 'type-check (typescript)',
+    }];
+    
+    t.deepEqual(places, expected);
+    t.end();
+});
+
+function getProcess({processors, plugins, extension}) {
+    return async (name) => {
+        const inputName = join(__dirname, 'fixture', `${name}.${extension}`);
+        const rawSource = await readFile(inputName, 'utf8');
+        
+        const options = {
+            dir: __dirname,
+            processors,
+            plugins,
+        };
+        
+        const fix = false;
+        const {
+            processedSource,
+            places,
+        } = await runProcessors({
+            fix,
+            name: inputName,
+            processFile: processFile({fix}),
+            options,
+            rawSource,
+        });
+        
+        return {
+            processedSource,
+            places,
+        };
+    };
+}
+
diff --git a/packages/putout/package.json b/packages/putout/package.json
@@ -144,6 +144,7 @@
     "@putout/processor-javascript": "^2.0.0",
     "@putout/processor-json": "^2.0.0",
     "@putout/processor-markdown": "^3.0.0",
+    "@putout/processor-typescript": "^1.0.0",
     "@putout/processor-yaml": "^1.0.0",
     "@putout/traverse": "^3.0.0",
     "chalk": "^4.0.0",
diff --git a/packages/putout/putout.json b/packages/putout/putout.json
@@ -10,7 +10,8 @@
         "ignore",
         "yaml",
         "css",
-        "html"
+        "html",
+        "typescript"
     ],
     "match": {
         "*.{js,jsx,mjs,cjs,ts,tsx}": {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "rules": {
 +        "putout": "on"
 +    }
 +}