Comparing version
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
const fs = require("fs"); | ||
const path = require("path"); | ||
const constants_1 = require("constants"); | ||
@@ -12,4 +13,4 @@ const command_1 = require("./command"); | ||
} | ||
InitCommand.samplePath = `${__dirname}/../../../sample/tyscan.yml`; | ||
InitCommand.samplePath = path.resolve(__dirname, '../../../sample/tyscan.yml'); | ||
exports.InitCommand = InitCommand; | ||
//# sourceMappingURL=initCommand.js.map |
@@ -12,3 +12,3 @@ "use strict"; | ||
if (fs.statSync(p).isDirectory()) { | ||
return fg.sync([`${p}/**/*.ts`, `${p}/**/*.tsx`]).map(e => e.toString()); | ||
return fg.sync([`${p}/**/*.{ts,tsx}`]).map(e => e.toString()); | ||
} | ||
@@ -15,0 +15,0 @@ return [p]; |
{ | ||
"name": "tyscan", | ||
"version": "0.3.1", | ||
"version": "0.3.2", | ||
"description": "Command line tool for scanning TypeScript sources", | ||
@@ -10,7 +10,7 @@ "bin": { | ||
"bin", | ||
"dist" | ||
"dist", | ||
"sample" | ||
], | ||
"scripts": { | ||
"build": "tsc --project tsconfig.json --outDir dist", | ||
"format": "tslint --fix --project tsconfig.json", | ||
"prepare": "npm run build", | ||
@@ -20,2 +20,3 @@ "test": "nyc mocha test/*.ts --no-timeouts", | ||
"docker": "docker build -t sider/tyscan:dev .", | ||
"smoke": "./test/smoke.sh", | ||
"release": "np" | ||
@@ -33,4 +34,4 @@ }, | ||
"dependencies": { | ||
"commander": "^2.19.0", | ||
"fast-glob": "^2.2.6", | ||
"commander": "^6.0.0", | ||
"fast-glob": "^3.2.2", | ||
"js-yaml": "^3.13.0", | ||
@@ -46,4 +47,4 @@ "parsimmon": "^1.12.0", | ||
"@types/js-yaml": "^3.12.1", | ||
"@types/mocha": "^5.2.6", | ||
"@types/node": "^11.13.10", | ||
"@types/mocha": "^8.0.0", | ||
"@types/node": "^14.0.5", | ||
"@types/parsimmon": "^1.10.0", | ||
@@ -54,8 +55,6 @@ "@types/prompt-sync": "^4.1.0", | ||
"chai": "^4.2.0", | ||
"mocha": "^5.2.0", | ||
"mocha": "^8.0.1", | ||
"np": "latest", | ||
"nyc": "^14.1.1", | ||
"nyc": "^15.0.1", | ||
"ts-node": "^8.1.0", | ||
"tslint": "^5.16.0", | ||
"tslint-config-airbnb": "^5.11.1", | ||
"tsutils": "^3.10.0", | ||
@@ -62,0 +61,0 @@ "typescript": "^3.4.5" |
@@ -6,20 +6,34 @@  | ||
[](https://badge.fury.io/js/tyscan) | ||
[](https://circleci.com/gh/sider/TyScan) | ||
TyScan is a command line tool for scanning TypeScript code. | ||
TyScan is a command-line tool for scanning TypeScript code by own custom rules. | ||
## Installation | ||
## Getting started | ||
1. Install TyScan and TypeScript with `npm`: | ||
1. Install TyScan and TypeScript: | ||
```shell | ||
```console | ||
$ npm install tyscan typescript --save-dev | ||
``` | ||
2. Check the installation: | ||
2. Verify the installation: | ||
```shell | ||
$ npx tyscan # Should print help message | ||
```console | ||
$ npx tyscan --version | ||
``` | ||
3. Create a rule file `tyscan.yml`: | ||
```console | ||
$ npx tyscan init | ||
``` | ||
4. Scan your TypeScript files: | ||
```console | ||
$ npx tyscan scan | ||
``` | ||
You can write your own rules into the generated `tyscan.yml` file. | ||
See the [documentation](#documentation) for more details. | ||
### Docker | ||
@@ -29,3 +43,3 @@ | ||
```shell | ||
```console | ||
$ docker run -it --rm -v "$PWD":/work sider/tyscan | ||
@@ -32,0 +46,0 @@ ``` |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
121193
1.18%16
-11.11%106
0.95%1557
0.06%59
31.11%+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
- Removed
Updated
Updated