Merge pull request #37 from obewds/dev

0.11.0 - adding js file deletion to install script and fixing bug in update profile info form compo for jetstream

README.md

@@ -53,6 +53,8 @@ Next up, you can check out the install so far using (vite will give you a link f
 npm run dev
 ```
 
+> NOTE: You may need to delete Jetstream's node_modules directory and reinstall node.js dependencies with a `npm install` command to get vite to play nicely with Jetstream defaults!
+
 
 ## Installing VILT DS
 
@@ -68,4 +70,12 @@ Once the VILT DS package is installed, you can access and run the VILT DS instal
 npx vilt-ds
 ```
 
+After your base VILT DS files are installed, you'll need to run the following command:
+
+```bash
+sail artisan ziggy:generate
+```
+
+The `sail artisan ziggy:generate` command will generate a Javascript file with current routes in it. Typescript needs this information downstream, so we need to update this file when new routes are established.
 
+For now, we can simply switch the ziggy generated file from a Javascript `.js` extension to a Typescript `.ts` extension, and move on with our project.

dist/helpers/remove-file.d.ts

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obewds/vilt-ds",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "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",

src/generators/jetstream/resources/js/Pages/Profile/Partials/generate-update-profile-information-form-vue.ts

@@ -172,7 +172,7 @@ return `<!-- ./resources/js/Pages/Profile/Partials/UpdateProfileInformationForm.
                 <div v-show="photoPreview" class="mt-2">
                     <span
                         class="block rounded-full w-20 h-20 bg-cover bg-no-repeat bg-center"
-                        :style="'background-image: url(\'' + photoPreview + '\');'"
+                        :style="'background-image: url(' + photoPreview + ');'"
                     />
                 </div>
 

src/helpers/remove-file.ts

@@ -0,0 +1,14 @@
+// ./src/helpers/remove-file.ts
+
+import fs from 'fs-extra'
+
+import cliSuccessMessage from './cli-success-message.js'
+import cwd from './cwd.js'
+
+export default function (filenamePath:string): void {
+
+    fs.removeSync( cwd + filenamePath)
+
+    cliSuccessMessage('.' + filenamePath + ' file was deleted successfully!', false, false)
+
+}

src/installers/install-vilt-ds-jetstream.ts

@@ -1,6 +1,7 @@
 // ./src/installers/install-vilt-ds-jetstream.ts
 
 import installFile from '../helpers/install-file.js'
+import removeFile from '../helpers/remove-file.js'
 
 // import client side deps and package scripts/mods for VILT DS and VueVentus
 import installJetstreamNpmDeps from '../installers/dependencies/install-jetstream-npm-deps.js'
@@ -245,4 +246,13 @@ export default function (): void {
     // install suggested VS Code Extensions for VILT DS
     installFile( '/.vscode/extensions.json', JSON.stringify(viltDsVscodeExtensions, null, 4) )
 
+    console.log(' ')
+
+    // delete javascript files now replaced by typescript files
+    removeFile( '/vite.config.js' )
+    removeFile( '/tailwind.config.js' )
+    removeFile( '/tailwind.config.js' )
+    removeFile( '/resources/js/bootstrap.js' )
+    removeFile( '/resources/js/app.js' )
+
 }

tests/helpers/remove-file.test.ts

@@ -0,0 +1,17 @@
+// ./tests/helpers/remove-file.test.ts
+
+import { describe, expect, test } from '@jest/globals'
+import fs from 'fs-extra'
+import cwd from '../../src/helpers/cwd.js'
+import projectFileDoesExist from '../../src/helpers/project-file-does-exist.js'
+import removeFile from '../../src/helpers/remove-file'
+
+describe('./src/helpers/remove-file module', () => {
+
+    test('module can be imported successfully', () => {
+
+        expect(removeFile).toBeTruthy()
+
+    })
+
+})