spec-up-t 1.1.3 → 1.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "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-gitignore-entries.js

@@ -0,0 +1,51 @@
+const fs = require('fs').promises;
+
+/**
+ * Reads the content of a file or returns an empty string if the file does not exist.
+ * @param {string} filePath - The path to the file.
+ * @returns {Promise<string>} - The content of the file or an empty string.
+ */
+async function readFileOrCreateEmpty(filePath) {
+    try {
+        return await fs.readFile(filePath, 'utf8');
+    } catch (error) {
+        if (error.code === 'ENOENT') {
+            return '';
+        }
+        throw error;
+    }
+}
+
+/**
+ * Updates the .gitignore file with the specified files.
+ * @param {string} gitignorePath - The path to the .gitignore file.
+ * @param {string[]} filesToAdd - The list of files to add to .gitignore.
+ */
+async function updateGitignore(gitignorePath, filesToAdd) {
+    try {
+        // Read the .gitignore file or create an empty one if it doesn't exist
+        let gitignoreContent = await readFileOrCreateEmpty(gitignorePath);
+
+        // Split the content into lines and remove empty lines
+        const gitignoreLines = gitignoreContent.split('\n').filter(line => line.trim() !== '');
+
+        // Add files to .gitignore if they are not already present
+        filesToAdd.forEach(file => {
+            if (!gitignoreLines.some(line => line.trim() === file.trim())) {
+                gitignoreLines.push(file.trim());
+            }
+        });
+
+        // Join the lines back into a single string
+        const updatedGitignoreContent = gitignoreLines.join('\n') + '\n';
+
+        // Write the updated content back to the .gitignore file
+        await fs.writeFile(gitignorePath, updatedGitignoreContent, 'utf8');
+
+        console.log('Updated .gitignore file');
+    } catch (error) {
+        console.error('Error updating .gitignore:', error.message);
+    }
+}
+
+module.exports = { updateGitignore};

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

@@ -0,0 +1,17 @@
+// Configuration
+const gitIgnoreEntries = {
+    gitignorePath: path.join(__dirname, '../../../../', '.gitignore'),
+    filesToAdd: ['node_modules',
+        '*.log',
+        'dist',
+        '*.bak',
+        '*.tmp',
+        '.DS_Store',
+        '.env',
+        'coverage',
+        'build',
+        '.history'
+],
+};
+
+module.exports = { gitIgnoreEntries };

package/src/install-from-boilerplate/config-system-files.js

@@ -1,3 +1,3 @@
-const systemFiles = ['main.sh','README.md','help.txt'];
+const systemFiles = ['README.md','.env.example'];
 
 module.exports = { systemFiles };

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

@@ -1,9 +1,11 @@
 const { configScriptsKeys } = 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);
-
 copySystemFiles();
+updateGitignore(gitIgnoreEntries.gitignorePath, gitIgnoreEntries.filesToAdd);
 
 console.log("✅ custom update done");