Add check for prereleases in installed packages (#10)

* Add check for prereleases in installed packages

* Update gitignore

* Add tests

Author: maastrich

.eslintrc.yml

@@ -6,4 +6,10 @@ env:
 extends: "eslint:recommended"
 parserOptions:
   ecmaVersion: 12
+overrides:
+# override for jest
+  - files:
+      - "**/*.test.js"
+    env:
+      jest: true
 rules: {}

.gitignore

@@ -1,7 +1,5 @@
-coverage
-
-# Created by https://www.toptal.com/developers/gitignore/api/macos,vim
-# Edit at https://www.toptal.com/developers/gitignore?templates=macos,vim
+# Created by https://www.toptal.com/developers/gitignore/api/macos,vim,node
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,vim,node
 
 ### macOS ###
 # General
@@ -10,7 +8,8 @@ coverage
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*
@@ -31,6 +30,150 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
 ### Vim ###
 # Swap
 [._]*.s[a-v][a-z]
@@ -52,5 +195,4 @@ tags
 # Persistent undo
 [._]*.un~
 
-
-# End of https://www.toptal.com/developers/gitignore/api/macos,vim
+# End of https://www.toptal.com/developers/gitignore/api/macos,vim,node

index.js

@@ -1,46 +1,27 @@
-const { readFileSync, statSync } = require("fs");
-
-const expectedLockfileVersion = 2;
-
-async function getPackage() {
-  return JSON.parse(readFileSync("package.json").toString("utf-8"));
-}
-
-async function getPackageLock() {
-  return JSON.parse(readFileSync("package-lock.json").toString("utf-8"));
-}
-
-async function hasYarnLock() {
-  try {
-    statSync("./yarn.lock");
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
-
-async function lint() {
-  if (await hasYarnLock()) {
-    process.stderr.write(`Unexpected yarn.lock file detected\n`);
-    process.exit(1);
-  }
-
-  process.stderr.write(
-    `Lintint package.json for package ${(await getPackage()).name}\n`
-  );
-
-  try {
-    const { lockfileVersion } = await getPackageLock();
-    if (lockfileVersion !== expectedLockfileVersion) {
-      process.stderr.write(
-        `Unexpected lockfileVersion, found “${lockfileVersion}”, expected “${expectedLockfileVersion}”\n`
-      );
+const checkLockVersion = require("./lib/checks/lockVersion");
+const checkForPreRelease = require("./lib/checks/preReleases");
+const hasYarnLock = require("./lib/checks/yarn");
+const { FatalError } = require("./lib/errors");
+const { getPackageLock, getPackage } = require("./lib/utils");
+
+function lint() {
+  const pkgLock = getPackageLock();
+  const pkgJson = getPackage();
+  const errors = [];
+  errors.push(hasYarnLock());
+  errors.push(checkLockVersion(pkgLock));
+  errors.push(checkForPreRelease(pkgJson));
+  for (const error of errors) {
+    if (error instanceof FatalError) {
+      process.stderr.write(`${error.message}\n`);
       process.exit(1);
     }
-  } catch (e) {
-    process.stderr.write(
-      `No package-lock.json file, ignoring lockfileVersion check\n`
-    );
+    if (error instanceof Error) {
+      process.stderr.write(`${error.message}\n`);
+    }
+    if (error) {
+      process.stderr.write(`${error}\n`);
+    }
   }
 }
 

lib/__tests__/lockVersion.test.js

@@ -0,0 +1,23 @@
+const { FatalError } = require("../errors");
+const checkLockVersion = require("../checks/lockVersion");
+
+describe("Check lockFile version", () => {
+  it("should return a fatal error", () => {
+    const result = checkLockVersion({
+      lockfileVersion: 1,
+    });
+    expect(result).toBeInstanceOf(FatalError);
+  });
+  it("Should return a non-fatal error", () => {
+    const result = checkLockVersion();
+    expect(result).toBeInstanceOf(Error);
+    expect(result).not.toBeInstanceOf(FatalError);
+  });
+
+  it("Should return undefined", () => {
+    const result = checkLockVersion({
+      lockfileVersion: 2,
+    });
+    expect(result).toBeUndefined();
+  });
+});

lib/__tests__/preReleases.test.js

@@ -0,0 +1,44 @@
+const { FatalError } = require("../errors");
+const checkForPreRelease = require("../checks/preReleases");
+
+describe("Check lockFile version", () => {
+  it("should return a fatal error on pre-released dependency", () => {
+    const result = checkForPreRelease({
+      dependencies: {
+        "@mobsuccess-devops/pre-release": "1.0.0-pr-1.0",
+      },
+    });
+    expect(result).toBeInstanceOf(FatalError);
+  });
+  it("should return a fatal error on pre-released devDependency", () => {
+    const result = checkForPreRelease({
+      devDependencies: {
+        "@mobsuccess-devops/pre-release": "1.0.0-pr-1.0",
+      },
+    });
+    expect(result).toBeInstanceOf(FatalError);
+  });
+  it("should return a fatal error on pre-released peerDependency", () => {
+    const result = checkForPreRelease({
+      peerDependencies: {
+        "@mobsuccess-devops/pre-release": "1.0.0-pr-1.0",
+      },
+    });
+    expect(result).toBeInstanceOf(FatalError);
+  });
+
+  it("Should return undefined", () => {
+    const result = checkForPreRelease({
+      dependencies: {
+        "@mobsuccess-devops/release": "1.0.0",
+      },
+      devDependencies: {
+        "@mobsuccess-devops/release": "1.0.0",
+      },
+      peerDependencies: {
+        "@mobsuccess-devops/release": "1.0.0",
+      },
+    });
+    expect(result).toBeUndefined();
+  });
+});

lib/__tests__/yarn.test.js

@@ -0,0 +1,19 @@
+jest.mock("fs");
+const { statSync } = require("fs");
+const hasYarnLock = require("../checks/yarn");
+const { FatalError } = require("../errors");
+
+jest.mocked(statSync).mockImplementationOnce((path) => {
+  if (/yarn\.lock$/.test(path)) {
+    return { isFile: () => true };
+  }
+});
+
+describe("Fail if yarn.lock exists", () => {
+  it("should fail", () => {
+    expect(hasYarnLock()).toBeInstanceOf(FatalError);
+  });
+  it("Should succeed", () => {
+    expect(hasYarnLock()).toBeUndefined();
+  });
+});

lib/checks/lockVersion.js

@@ -0,0 +1,18 @@
+const { FatalError } = require("../errors");
+
+const expectedLockfileVersion = 2;
+
+function checkLockVersion(lockFile) {
+  if (!lockFile) {
+    return new Error(
+      "No package-lock.json file, ignoring lockfileVersion check"
+    );
+  }
+  if (lockFile.lockfileVersion !== expectedLockfileVersion) {
+    return new FatalError(
+      `Unexpected lockfileVersion, found “${lockFile.lockfileVersion}”, expected “${expectedLockfileVersion}”`
+    );
+  }
+}
+
+module.exports = checkLockVersion;

lib/checks/preReleases.js

@@ -0,0 +1,19 @@
+const { FatalError } = require("../errors");
+
+function checkForPreRelease(pkgJson) {
+  const {
+    dependencies = {},
+    devDependencies = {},
+    peerDependencies = {},
+  } = pkgJson;
+  const deps = { ...dependencies, ...devDependencies, ...peerDependencies };
+  for (const [name, version] of Object.entries(deps)) {
+    if (/^@mobsuccess-devops/.test(name) && /-pr-(\d+)\.(\d+)$/.test(version)) {
+      return new FatalError(
+        `Unexpected pre-release dependency found: ${name}@${version}\n`
+      );
+    }
+  }
+}
+
+module.exports = checkForPreRelease;