tyscan - npm Package Compare versions
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
Improved metrics
- Total package byte prevSize
121193
1.18%- Dev dependency count
16
-11.11%- Number of downloads
4
100%- Number of package files
106
0.95%- Lines of code
1557
0.06%- Number of lines in readme file
59
31.11%Dependency changes
+ Added
@nodelib/fs.scandir@2.1.5(transitive)+ Added
@nodelib/fs.stat@2.0.5(transitive)+ Added
@nodelib/fs.walk@1.2.8(transitive)+ Added
braces@3.0.3(transitive)+ Added
commander@6.2.1(transitive)+ Added
fast-glob@3.3.3(transitive)+ Added
fastq@1.19.1(transitive)+ Added
fill-range@7.1.1(transitive)+ Added
glob-parent@5.1.2(transitive)+ Added
is-number@7.0.0(transitive)+ Added
micromatch@4.0.8(transitive)+ Added
picomatch@2.3.1(transitive)+ Added
queue-microtask@1.2.3(transitive)+ Added
reusify@1.1.0(transitive)+ Added
run-parallel@1.2.0(transitive)+ Added
to-regex-range@5.0.1(transitive)- Removed
@mrmlnc/readdir-enhanced@2.2.1(transitive)- Removed
@nodelib/fs.stat@1.1.3(transitive)- Removed
arr-diff@4.0.0(transitive)- Removed
arr-flatten@1.1.0(transitive)- Removed
arr-union@3.1.0(transitive)- Removed
array-unique@0.3.2(transitive)- Removed
assign-symbols@1.0.0(transitive)- Removed
atob@2.1.2(transitive)- Removed
base@0.11.2(transitive)- Removed
braces@2.3.2(transitive)- Removed
cache-base@1.0.1(transitive)- Removed
call-me-maybe@1.0.2(transitive)- Removed
class-utils@0.3.6(transitive)- Removed
collection-visit@1.0.0(transitive)- Removed
commander@2.20.3(transitive)- Removed
component-emitter@1.3.1(transitive)- Removed
copy-descriptor@0.1.1(transitive)- Removed
debug@2.6.9(transitive)- Removed
decode-uri-component@0.2.2(transitive)- Removed
define-property@0.2.51.0.02.0.2(transitive)- Removed
expand-brackets@2.1.4(transitive)- Removed
extend-shallow@2.0.13.0.2(transitive)- Removed
extglob@2.0.4(transitive)- Removed
fast-glob@2.2.7(transitive)- Removed
fill-range@4.0.0(transitive)- Removed
for-in@1.0.2(transitive)- Removed
fragment-cache@0.2.1(transitive)- Removed
function-bind@1.1.2(transitive)- Removed
get-value@2.0.6(transitive)- Removed
glob-parent@3.1.0(transitive)- Removed
glob-to-regexp@0.3.0(transitive)- Removed
has-value@0.3.11.0.0(transitive)- Removed
has-values@0.1.41.0.0(transitive)- Removed
hasown@2.0.2(transitive)- Removed
is-accessor-descriptor@1.0.1(transitive)- Removed
is-buffer@1.1.6(transitive)- Removed
is-data-descriptor@1.0.1(transitive)- Removed
is-descriptor@0.1.71.0.3(transitive)- Removed
is-extendable@0.1.11.0.1(transitive)- Removed
is-glob@3.1.0(transitive)- Removed
is-number@3.0.0(transitive)- Removed
is-plain-object@2.0.4(transitive)- Removed
is-windows@1.0.2(transitive)- Removed
isarray@1.0.0(transitive)- Removed
isobject@2.1.03.0.1(transitive)- Removed
kind-of@3.2.24.0.06.0.3(transitive)- Removed
map-cache@0.2.2(transitive)- Removed
map-visit@1.0.0(transitive)- Removed
micromatch@3.1.10(transitive)- Removed
mixin-deep@1.3.2(transitive)- Removed
ms@2.0.0(transitive)- Removed
nanomatch@1.2.13(transitive)- Removed
object-copy@0.1.0(transitive)- Removed
object-visit@1.0.1(transitive)- Removed
object.pick@1.3.0(transitive)- Removed
pascalcase@0.1.1(transitive)- Removed
path-dirname@1.0.2(transitive)- Removed
posix-character-classes@0.1.1(transitive)- Removed
regex-not@1.0.2(transitive)- Removed
repeat-element@1.1.4(transitive)- Removed
repeat-string@1.6.1(transitive)- Removed
resolve-url@0.2.1(transitive)- Removed
ret@0.1.15(transitive)- Removed
safe-regex@1.1.0(transitive)- Removed
set-value@2.0.1(transitive)- Removed
snapdragon@0.8.2(transitive)- Removed
snapdragon-node@2.1.1(transitive)- Removed
snapdragon-util@3.0.1(transitive)- Removed
source-map@0.5.7(transitive)- Removed
source-map-resolve@0.5.3(transitive)- Removed
source-map-url@0.4.1(transitive)- Removed
split-string@3.1.0(transitive)- Removed
static-extend@0.1.2(transitive)- Removed
to-object-path@0.3.0(transitive)- Removed
to-regex@3.0.2(transitive)- Removed
to-regex-range@2.1.1(transitive)- Removed
union-value@1.0.1(transitive)- Removed
unset-value@1.0.0(transitive)- Removed
urix@0.1.0(transitive)- Removed
use@3.1.1(transitive)Updated
commander@^6.0.0Updated
fast-glob@^3.2.2