sv-arcgis 1.3.2 → 1.3.3

package/README.md

@@ -1,9 +1,35 @@
+## ❓ What does this do?
+
+It's an ~opinionated way to setup a Svelte or SvelteKit and ArcGIS project. It'll give you everything you need to get going quickly and will set default locations for things like config.js|ts and your .env file.
+
+Here are the prompts that are asked when running the tool (all are optional):
+
+**(config)**
+
+- Enter your appName
+- Enter your baseUrl (e.g. /)
+- Enter your Portal URL
+- Enter your webmapId
+- Enter your appId
+
+**(env)**
+
+- Enter your ArcGIS API key
+- Enter your ArcGIS Client ID
+- Enter your ArcGIS Client Secret
+
+**(ui)**
+
+- Do you need the Security Classification bars above and below on the UI?
+- Do you want to use Calcite Components?
+- Would you like a demo page?
+
 ## 🎬 Repo / NPM
 
 - [repo](https://github.com/joe-allen/sv-arcgis)
 - [npm](https://www.npmjs.com/package/sv-arcgis)
 
-## 🎬 Prereqs
+## 📋 Prereqs
 
 - SvelteKit: `npx sv create [project_name]`
 - (Or Svelte: `npm create vite@latest`)
@@ -21,9 +47,11 @@
 
 ## 🗺️ Roadmap
 
-- Create CI / CD (w/ tests)
-- Create tests (see https://www.youtube.com/watch?v=Xk8yaN9_PZA)
-- Option for / intergrate OAuth2 https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/arcgis-apis/
+- [ ] Option for / intergrate OAuth2 https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/arcgis-apis/
+- [ ] Add prompt for ArcGIS Charts / Code components?
+- [ ] Create CI / CD (w/ tests)
+- [ ] Create tests (see https://www.youtube.com/watch?v=Xk8yaN9_PZA)
+- [ ] When selecting demo for Svelte (vite) currently we're only importing the component. Update the script to drop `<ArcGIS />` something in the html
 - [x] Update to work Svelte / Vite app (not just Kit)? (Demo would need to be different)
 
 ## 🙏 Help

package/bin/sv-arcgis-setup.js

@@ -749,7 +749,7 @@ if (demo.DEMO === true) {
 
   fs.writeFileSync(demoPagePath, demoPageContent);
   if (isSvelte) {
-    console.log(\`✅ Created demo page at ./src/lib/arcgis/ArcGIS.svelte\`);
+    console.log(\`✅ Created demo page at ./src/lib/ArcGIS.svelte\`);
   } else {
     console.log(\`✅ Created demo page at ./src/routes/arcgis/+page.svelte\`);
   }
@@ -838,7 +838,7 @@ generateConfig()
         fs.writeFileSync(configFilePath, configFileText, { encoding: 'utf8', flag: 'w' });
 
         // Show that config was written
-        console.log(\`✅ Updated config at \` + chalk.bold(\`/src/lib/config/index.\${usesTypeScript ? 'ts' : 'js'}\`));
+        console.log(\`✅ Updated config at \` + chalk.bold(\`./src/lib/config/index.\${usesTypeScript ? 'ts' : 'js'}\`));
       }
 
       if (!global.arcGisApiKeyIsNull || !global.arcGisClientIdIsNull || !global.arcGisClientSecretIsNull) {
@@ -847,7 +847,7 @@ generateConfig()
         fs.writeFileSync(envFilePath, envFileText, { encoding: 'utf8', flag: 'w' });
 
         // Show that env was written
-        console.log(\`✅ Updated env file at \` + chalk.bold(\`.env\`));
+        console.log(\`✅ Updated env file at \` + chalk.bold(\`./.env\`));
         console.log(\`👀 Tip: Make sure your .gitignore has the line: .env\`);
       }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sv-arcgis",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "main": "index.js",
   "bin": {
     "sv-arcgis": "./bin/sv-arcgis-setup.js"