@lipemat/js-boilerplate-shared 0.0.5 → 0.1.0

package/README.md

@@ -1 +1,6 @@
 "# js-boilerplate-shared" 
+
+
+## Scripts
+
+* `js-boilerplate-shared__fix-pnp`: Fixes PNP compatibility issues

package/bin/fix-pnp.ts

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+/**
+ * When using PNP loose mode, we get warnings for every module
+ * we access, not strictly declared.
+ *
+ * No built-in way in Yarn to disable the warnings.
+ * This script modifies to generate .pnp.js file to suppress
+ * all loose module warnings unless the environmental variable
+ * it set to display all warnings.
+ *
+ * @example
+ * ```json
+ * {
+ *      "scripts": {
+ *           "postinstall": "lipemat-js-boilerplate fix-pnp"
+ *      }
+ *  }
+ * ```
+ */
+
+import fs from 'fs';
+
+const PNP_FILES = [
+	'./.pnp.js',
+	'./.pnp.cjs',
+	'./.pnp.mjs',
+];
+
+PNP_FILES.forEach( PNP_FILE => {
+	if ( fs.existsSync( PNP_FILE ) ) {
+		fs.readFile( PNP_FILE, 'utf8', ( readError, data ) => {
+			if ( readError ) {
+				return console.error( readError );
+			}
+
+			const result = data.replace( /if \(reference != null\) {/, '// # Warnings suppressed via @lipemat/js-boilerplate/fix-pnp script. \n' +
+				'if (! alwaysWarnOnFallback && reference != null) { \n' +
+				'dependencyReference = reference; \n' +
+				'} else if (alwaysWarnOnFallback && reference != null) {' );
+
+			fs.writeFile( PNP_FILE, result, 'utf8', writeError => {
+				if ( writeError ) {
+					return console.error( writeError );
+				}
+				console.debug( `The ${PNP_FILE} file has been adjusted to no longer display warnings for loose modules.` );
+			} );
+		} );
+	}
+} );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lipemat/js-boilerplate-shared",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "license": "MIT",
   "description": "Shared utilities for all @lipemat boilerplate packages",
   "engines": {
@@ -21,6 +21,9 @@
     "url": "https://github.com/lipemat/js-boilerplate-shared/issues"
   },
   "homepage": "https://github.com/lipemat/js-boilerplate-shared#readme",
+  "bin": {
+    "js-boilerplate-shared__fix-pnp": "bin/fix-pnp.ts"
+  },
   "scripts": {
     "build": "tsc --project ./bin",
     "lint": "eslint --fix --cache",