sku 11.6.2 → 11.7.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # sku
 
+## 11.7.0
+
+### Minor Changes
+
+- Add `package.json` configuration flags that enable you to skip sku configuration and peer dep validation ([#727](https://github.com/seek-oss/sku/pull/727))
+
+  **NOTE**: These settings disable critical functionality of sku, so you likely
+  don't want to use them unless you know what you're doing
+
+  - `skuSkipConfigure`: Skip generation of config files. E.g. .prettierrc, tsconfig.json, etc.
+  - `skuSkipValidatePeerDeps`: Skip checking for multiple copies of the same package. You likely want to try and fix the warnings found by this check rather than disabling it.
+
+  **EXAMPLE USAGE**:
+
+  ```jsonc
+  // package.json
+  {
+    "skuSkipConfigure": true,
+    "skuSkipValidatePeerDeps": true
+  }
+  ```
+
 ## 11.6.2
 
 ### Patch Changes

package/bin/sku.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
+const fs = require('fs-extra');
 const debug = require('debug');
 const args = require('../config/args');
-const validatePeersDeps = require('../lib/validatePeersDeps');
+const _validatePeerDeps = require('../lib/validatePeerDeps');
+const { getPathFromCwd } = require('../lib/cwd');
 const log = debug('sku:bin');
 
 const { script } = args;
@@ -13,11 +15,42 @@ if (args.debug) {
   debug.enable(process.env.DEBUG);
 }
 
+let skipConfigure = false;
+let skipValidatePeerDeps = false;
+const packageJson = getPathFromCwd('./package.json');
+const packageJsonExists = fs.existsSync(packageJson);
+
+if (packageJsonExists) {
+  const {
+    skuSkipConfigure = false,
+    skuSkipValidatePeerDeps = false,
+  } = require(packageJson);
+  skipConfigure = skuSkipConfigure;
+  skipValidatePeerDeps = skuSkipValidatePeerDeps;
+}
+
 const configureProject = async () => {
+  if (skipConfigure) {
+    log(`"skuSkipConfigure" set in ${packageJson}, skipping sku configuration`);
+    return;
+  }
+
   const configure = require('../lib/configure');
   await configure();
 };
 
+const validatePeerDeps = () => {
+  if (skipValidatePeerDeps) {
+    log(
+      `"skuSkipValidatePeerDeps" set in ${packageJson}, skipping sku peer dependency validation`,
+    );
+    return;
+  }
+
+  // Intentionally not awaiting async function as it's just for logging warnings
+  _validatePeerDeps();
+};
+
 const runScript = (scriptName) => {
   require(`../scripts/${scriptName}`);
 };
@@ -52,8 +85,7 @@ log(`Starting script: ${script}`);
     case 'serve': {
       await configureProject();
 
-      // Intentionally not awaiting async function as it's just for logging warnings
-      validatePeersDeps();
+      validatePeerDeps();
       runScript(script);
       break;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sku",
-  "version": "11.6.2",
+  "version": "11.7.0",
   "description": "Front-end development toolkit, powered by Webpack, Babel, CSS Modules, Less and Jest",
   "main": "index.js",
   "bin": {