@microsoft/type2docfx 2.0.7-dev.1289218.0 → 2.0.7-dev.1303134.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/type2docfx",
-  "version": "2.0.7-dev.1289218.0",
+  "version": "2.0.7-dev.1303134.0",
   "description": "A tool to convert json format output from TypeDoc to schema driven reference model for DocFx to consume.",
   "main": "./dist/main.js",
   "bin": {
@@ -9,9 +9,12 @@
   "scripts": {
     "build": "tsc",
     "start": "ts-node src/cli.ts",
-    "test": "ts-node node_modules/jest/bin/jest.js  --silent --findRelatedTests tests/type2docfx.integration.test.ts tests/type2docfx.test.ts",
+    "test": "ts-node node_modules/jest/bin/jest.js",
     "test:unit": "ts-node node_modules/jest/bin/jest.js  --silent --findRelatedTests tests/type2docfx.test.ts",
     "prepublishOnly": "tsc",
+    "prepare": "husky install",
+    "dprint": "dprint fmt",
+    "lint": "node tasks/check.js",
     "coverage": "jest --coverage"
   },
   "repository": {
@@ -35,11 +38,18 @@
     "@types/js-yaml": "^4.0.5",
     "@types/lodash": "^4.14.149",
     "@types/rewire": "^2.5.28",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "chalk": "^4.1.2",
+    "dprint": "^0.36.1",
+    "eslint": "^8.39.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-security": "^1.7.1",
+    "husky": "^8.0.3",
     "jest": "^27.0.6",
+    "lint-staged": "^13.2.2",
     "rewire": "^6.0.0",
     "ts-jest": "^27.1.5",
-    "ts-node": "^10.9.1",
-    "tslint": "^6.1.3"
+    "ts-node": "^10.9.1"
   },
   "dependencies": {
     "commander": "^9.4.1",
@@ -49,6 +59,12 @@
     "prettier": "^2.8.7",
     "typedoc": "^0.23.28"
   },
+  "lint-staged": {
+    "**/*.{ts, json, js}": [
+      "npm run dprint",
+      "npm run lint"
+    ]
+  },
   "publishConfig": {
     "tag": "dev",
     "registry": "https://registry.npmjs.org/"

package/tasks/check.js

@@ -0,0 +1,29 @@
+const chalk = require("chalk")
+
+function checkPackageVersionSame() {
+    const packageVersion = require("../package.json").version;
+    const lockVersion = require("../npm-shrinkwrap.json").version;
+
+    if (packageVersion !== lockVersion) {
+        console.log(`vension in packeg.json does not match version in npm-shrinkwrap.json, please run ${chalk.red.bold("npm install")} to update version in npm-shrinkwrap.json`)
+        process.exit(1);
+    }
+
+}
+
+function checkExistADOArtifictDependencies() {
+    const packages = require("../npm-shrinkwrap.json").packages
+    for(const [key,value] of Object.entries(packages)) {
+        if(value.resolved && !value.resolved.startsWith("https://registry.npmjs.org/")) {
+            console.log(`some dependencies are not come from registry.npmjs.org, please comment ${chalk.red(".npmrc file")} and reinstall ${chalk.red.bold(key)} in npm-shrinkwrap.json`)
+            process.exit(1);
+        }
+    }
+}
+
+function check() {
+    checkPackageVersionSame();
+    checkExistADOArtifictDependencies();
+}
+
+check()

package/tsconfig.json

@@ -1,19 +1,15 @@
 {
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "node_modules"
-    ],
-    "compilerOptions": {
-        "noImplicitAny": true,
-        "sourceMap": true,
-        "outDir": "dist",
-        "target": "es2020",
-        "lib": ["es2020"],
-        "esModuleInterop": true,
-        "module": "commonjs",
-        "moduleResolution": "node",
-        "allowJs": true
-    }
-}
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "noImplicitAny": true,
+    "sourceMap": true,
+    "outDir": "dist",
+    "target": "es2020",
+    "lib": ["es2020"],
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "allowJs": true
+  }
+}