spec-up-t 1.1.7 → 1.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Technical specification drafting tool that generates rich specification documents from markdown. Forked from https://github.com/decentralized-identity/spec-up by Daniel Buchner (https://github.com/csuwildcat)",
   "main": "./index",
   "repository": {

package/src/install-from-boilerplate/add-scripts-keys.js

@@ -1,10 +1,14 @@
 const fs = require('fs');
 const path = require('path');
 
-// Function to add scripts to package.json
-function addScriptsKeys(scriptKeys) {
-    // Path to the package.json of the project where this script is run
-    const packageJsonPath = path.resolve(__dirname, '../../../../', 'package.json');
+/**
+ * Adds scripts to the package.json file.
+ * 
+ * @param {Object} scriptKeys - An object containing the scripts to add.
+ * @param {Object} [overwriteKeys={}] - An object specifying which scripts to overwrite if they already exist.
+ */
+function addScriptsKeys(scriptKeys, overwriteKeys = {}) {
+    const packageJsonPath = path.resolve(process.cwd(), 'package.json');
 
     // Read the package.json file
     fs.readFile(packageJsonPath, 'utf8', (err, data) => {
@@ -22,9 +26,9 @@ function addScriptsKeys(scriptKeys) {
                 packageJson.scripts = {};
             }
 
-            // Add new scripts without overwriting existing ones
+            // Add new scripts without overwriting existing ones unless specified in overwriteKeys
             for (const [key, value] of Object.entries(scriptKeys)) {
-                if (!packageJson.scripts[key]) {
+                if (!packageJson.scripts[key] || overwriteKeys[key]) {
                     packageJson.scripts[key] = value;
                 }
             }
@@ -44,4 +48,16 @@ function addScriptsKeys(scriptKeys) {
 }
 
 // Export the function
-module.exports = addScriptsKeys;
+module.exports = addScriptsKeys;
+
+/*
+
+// Example usage:
+const configScriptsKeys = {  ...  };
+const overwriteConfig = { "edit": true }; // Overwrite only "edit" script
+
+addScriptsKeys(configScriptsKeys); // Do not overwrite any existing scripts
+
+addScriptsKeys(configScriptsKeys, overwriteConfig);  // Overwrite specified existing scripts 
+
+*/

package/src/install-from-boilerplate/config-gitignore-entries.js

@@ -2,7 +2,7 @@ const path = require('path');
 
 // Configuration
 const gitIgnoreEntries = {
-    gitignorePath: path.join(__dirname, '../../../../', '.gitignore'),
+    gitignorePath: path.join(process.cwd(), '.gitignore'),
     filesToAdd: ['node_modules',
         '*.log',
         'dist',

package/src/install-from-boilerplate/config-scripts-keys.js

@@ -14,4 +14,21 @@ const configScriptsKeys = {
     "custom-update": "npm update && node -e \"require('spec-up-t/src/install-from-boilerplate/custom-update.js')\""
 };
 
-module.exports = { configScriptsKeys };
+// Defines which script keys to overwrite. If a key is not present, it will not be overwritten
+const configOverwriteScriptsKeys = {
+    "edit": true,
+    "render": true,
+    "dev": true,
+    "collectExternalReferencesCache": true,
+    "collectExternalReferencesNoCache": true,
+    "topdf": true,
+    "freeze": true,
+    "references": true,
+    "help": true,
+    "menu": true,
+    "addremovexrefsource": true,
+    "configure": true,
+    "custom-update": true
+};
+
+module.exports = { configScriptsKeys, configOverwriteScriptsKeys };

package/src/install-from-boilerplate/custom-update.js

@@ -1,10 +1,12 @@
 const { configScriptsKeys } = require('./config-scripts-keys');
+const { configOverwriteScriptsKeys } = require('./config-scripts-keys');
 const addScriptsKeys = require('./add-scripts-keys');
 const copySystemFiles = require('./copy-system-files');
 const { gitIgnoreEntries } = require('./config-gitignore-entries');
 const {updateGitignore} = require('./add-gitignore-entries');
 
-addScriptsKeys(configScriptsKeys);
+
+addScriptsKeys(configScriptsKeys, configOverwriteScriptsKeys);
 copySystemFiles();
 updateGitignore(gitIgnoreEntries.gitignorePath, gitIgnoreEntries.filesToAdd);