Merge pull request #9 from obewds/dev

0.1.7 - refining cli code structure and naming conventions to get ready for more complex installable files/code

dist/generators/jetstream/generateConfigJetstream.d.ts

@@ -0,0 +1 @@
+export default function (jetstreamGitignoreText: string): string;

dist/helpers/cliSuccessMessage.d.ts

@@ -0,0 +1 @@
+export default function (string: string, prefixLineBreak?: boolean, suffixLineBreak?: boolean): void;

dist/helpers/cliWarningMessage.d.ts

@@ -0,0 +1 @@
+export default function (string: string, prefixLineBreak?: boolean, suffixLineBreak?: boolean): void;

dist/helpers/projectFileDoesExist.d.ts

@@ -0,0 +1 @@
+export default function (filepath: string): boolean;

dist/updaters/jetstream/updateJetstreamGitignore.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package.json

@@ -1,18 +1,18 @@
 {
   "name": "@obewds/vilt-ds",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "The official repository for the VILT Design System for the Vue.js, Inertia.js, Laravel, and Tailwind CSS web app stack that is turbocharged with Typescript and VueVentus.",
   "license": "MIT",
   "author": "Matt McT",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
-    "build": "tsc",
+    "build": "npx rimraf dist && tsc",
     "pkg:org": "npm config set scope obewds",
     "tag": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags",
-    "bump:patch": "npm version patch && npx rimraf dist && npm run build",
-    "bump:minor": "npm version minor && npx rimraf dist && npm run build",
-    "bump:major": "npm version major && npx rimraf dist && npm run build"
+    "bump:patch": "npm version patch && npm run build",
+    "bump:minor": "npm version minor && npm run build",
+    "bump:major": "npm version major && npm run build"
   },
   "files": [
     "dist"

src/generators/jetstream/generateConfigJetstream.ts

@@ -0,0 +1,35 @@
+// ./src/generators/jetstream/generateConfigJetstream.ts
+
+import fs from 'fs-extra'
+
+import cwd from '../../helpers/cwd.js'
+import projectFileDoesExist from '../../helpers/projectFileDoesExist.js'
+
+export default function (jetstreamGitignoreText:string): string {
+
+    const filename = 'jetstream.php'
+    const filepath = '/config/' + filename
+
+    if ( projectFileDoesExist(filepath) ) {
+
+        fs.readFile(cwd + filepath, 'utf8', function(err, data) {
+
+            // error check
+            if (err) { throw err }
+
+            let modifiedData = String(data).replace(
+                /\/\/Features::termsAndPrivacyPolicy(),/g, 'Features::termsAndPrivacyPolicy(),'
+            ).replace(
+                /\/\/Features::api(),/g, 'Features::api(),'
+            )
+
+            // If no error, then overwrite the current gitignore file content wrapped in VILT DS gitignore code
+            // fs.outputFileSync(cwd + filepath, generateJetstreamGitignore(String(data)), { flag: 'w+' })
+
+        })
+
+    }
+
+    return ''
+
+}

src/generators/jetstream/generateJetstreamGitignore.ts

@@ -15,7 +15,6 @@ ${developer}
 ${mac}
 
 ${windows}
-
 `;
 
 }

src/helpers/cliSuccessMessage.ts

@@ -0,0 +1,13 @@
+// ./cli/helpers/cliSuccessMessage.ts
+
+import gradientText from './gradientText.js'
+
+export default function (string:string, prefixLineBreak:boolean = false, suffixLineBreak:boolean = false): void {
+
+    if (prefixLineBreak) { console.log(' ') }
+
+    console.log(gradientText(string))
+
+    if (suffixLineBreak) { console.log(' ') }
+
+}

src/helpers/cliWarningMessage.ts

@@ -0,0 +1,13 @@
+// ./cli/helpers/cliWarningMessage.ts
+
+import gradient from 'gradient-string'
+
+export default function (string:string, prefixLineBreak:boolean = false, suffixLineBreak:boolean = false): void {
+
+    if (prefixLineBreak) { console.log(' ') }
+
+    console.log(gradient.morning(string))
+
+    if (suffixLineBreak) { console.log(' ') }
+
+}

src/helpers/projectFileDoesExist.ts

@@ -0,0 +1,20 @@
+// ./src/helpers/projectFileDoesExist.ts
+
+import fs from 'fs-extra'
+
+import cwd from './cwd.js'
+
+export default function (filepath:string): boolean {
+
+    const currentFilepath = cwd + filepath
+
+    try {
+        if (fs.existsSync(currentFilepath)) {
+            return true
+        }
+    } catch(err) {
+        console.error(err)
+        return false
+    }
+
+}

src/index.ts

@@ -11,14 +11,15 @@ import installViltDsJetstream from './installers/installViltDsJetstream.js'
 
 let userInstallation: ViltDsInstallationChoice = null
 
+// Show a starting CLI greeting message
 cliStartMessage()
 
+// Inquire the type of installation type from the cli user
 userInstallation = await selectInstallation()
-
 console.log(' ')
 
+// For a standard installation with an existing
+// Laravel + Jetstream install in a current working (root) directory
 if (userInstallation === 'Install VILT DS Into A Laravel Jetstream Starter App') {
-
     installViltDsJetstream()
-
 }

src/installers/installViltDsJetstream.ts

@@ -1,9 +1,12 @@
 // ./src/installers/installViltDsJetstream.ts
 
-import installJetstreamGitignore from '../installers/jetstream/installJetstreamGitignore.js'
+import updateConfigJetstream from '../updaters/jetstream/updateConfigJetstream.js'
+import updateJetstreamGitignore from '../updaters/jetstream/updateJetstreamGitignore.js'
 
 export default function (): void {
 
-    installJetstreamGitignore()
+    updateJetstreamGitignore()
+
+    updateConfigJetstream()
 
 }