Add update notifier

zeplin · Jan 22, 2021 · 0774101 · 0774101
1 parent 96a4ea8
commit 0774101
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -2,10 +2,10 @@
   "name": "@zeplin/cli-connect-react-plugin",
   "version": "0.2.8",
   "description": "Zeplin CLI Connected Components - React Plugin",
-  "main": "./dist/index",
+  "main": "./dist/src/index",
   "scripts": {
     "test": "jest",
-    "copy-templates": "copyfiles -u 1 src/template/** dist/",
+    "copy-templates": "copyfiles -u 1 src/template/** dist/src",
     "build:dev": "npm run build -- --sourceMap",
     "build": "rimraf dist/ && npm run copy-templates && tsc",
     "lint": "eslint --ext .js,.ts .",
@@ -31,6 +31,7 @@
     "@types/node": "^13.13.5",
     "@types/pug": "^2.0.4",
     "@types/react": "^17.0.0",
+    "@types/update-notifier": "^5.0.0",
     "@typescript-eslint/eslint-plugin": "^2.31.0",
     "@typescript-eslint/parser": "^2.31.0",
     "@zeplin/cli": "^1.0.4",
@@ -49,6 +50,7 @@
     "fs-extra": "^9.0.1",
     "pug": "^2.0.4",
     "react-docgen": "^5.3.1",
-    "react-docgen-typescript": "^1.20.5"
+    "react-docgen-typescript": "^1.20.5",
+    "update-notifier": "^5.0.1"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -6,12 +6,23 @@ import pug from "pug";
 import { readFile, pathExists } from "fs-extra";
 import { ComponentDoc, parse, PreparedComponentDoc, Props } from "react-docgen";
 import * as docgen from "react-docgen-typescript";
+import updateNotifier from "update-notifier";
+import { name as packageName, version as packageVersion } from "../package.json";
 
 interface ReactPluginConfig {
     tsDocgen?: "react-docgen" | "react-docgen-typescript";
     tsConfigPath?: string;
 }
 
+updateNotifier({
+    pkg: {
+        name: packageName,
+        version: packageVersion
+    },
+    updateCheckInterval: 0,
+    shouldNotifyInNpmScript: true
+}).notify();
+
 export default class implements ConnectPlugin {
     supportedFileExtensions = [".js", ".jsx", ".ts", ".tsx"];
     tsExtensions = [".ts", ".tsx"];

diff --git a/tsconfig.test.json → test/tsconfig.test.json b/tsconfig.test.json → test/tsconfig.test.json
@@ -5,6 +5,7 @@
       "lib": ["es5", "es6", "dom"],
       "noImplicitAny": false,
       "esModuleInterop": true,
+      "resolveJsonModule": true,
       "sourceMap": true,
       "outDir": "lib",
       "jsx": "react"

diff --git a/test/typescript.test.ts b/test/typescript.test.ts
@@ -74,7 +74,7 @@ describe("Connected Components React Plugin - TypeScript", () => {
 
             processor.config = {
                 tsDocgen: "react-docgen-typescript",
-                tsConfigPath: "./tsconfig.test.json"
+                tsConfigPath: "./test/tsconfig.test.json"
             };
 
             const componentCode = await processor.process(
@@ -92,7 +92,7 @@ describe("Connected Components React Plugin - TypeScript", () => {
 
             processor.config = {
                 tsDocgen: "react-docgen-typescript",
-                tsConfigPath: "./tsconfig.test.json"
+                tsConfigPath: "./test/tsconfig.test.json"
             };
 
             const componentCode = await processor.process(
@@ -110,7 +110,7 @@ describe("Connected Components React Plugin - TypeScript", () => {
 
             processor.config = {
                 tsDocgen: "react-docgen-typescript",
-                tsConfigPath: "./tsconfig.test.json"
+                tsConfigPath: "./test/tsconfig.test.json"
             };
 
             const componentCode = await processor.process(
@@ -128,7 +128,7 @@ describe("Connected Components React Plugin - TypeScript", () => {
 
             processor.config = {
                 tsDocgen: "react-docgen-typescript",
-                tsConfigPath: "./tsconfig.test.json"
+                tsConfigPath: "./test/tsconfig.test.json"
             };
 
             const componentCode = await processor.process(
@@ -146,7 +146,7 @@ describe("Connected Components React Plugin - TypeScript", () => {
 
             processor.config = {
                 tsDocgen: "react-docgen-typescript",
-                tsConfigPath: "./tsconfig.test.json"
+                tsConfigPath: "./test/tsconfig.test.json"
             };
 
             const componentCode = await processor.process(

diff --git a/tsconfig.json b/tsconfig.json
@@ -11,6 +11,7 @@
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
     "esModuleInterop": true,
+    "resolveJsonModule": true,
     "moduleResolution": "node",
     "baseUrl": ".",
     "paths": {