@springmicro/cli 0.2.0-alpha.1 → 0.2.0-alpha.2

package/README.md

@@ -26,7 +26,7 @@ $ npm install -g @springmicro/cli
 $ springmicro COMMAND
 running command...
 $ springmicro (--version)
-@springmicro/cli/0.2.0-alpha.1 win32-x64 node-v20.15.0
+@springmicro/cli/0.2.0-alpha.2 win32-x64 node-v20.15.0
 $ springmicro --help [COMMAND]
 USAGE
   $ springmicro COMMAND
@@ -81,7 +81,7 @@ EXAMPLES
   $ springmicro add auth
 ```
 
-_See code: [src/commands/add/auth.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.1/src/commands/add/auth.ts)_
+_See code: [src/commands/add/auth.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.2/src/commands/add/auth.ts)_
 
 ## `springmicro help [COMMAND]`
 
@@ -124,7 +124,7 @@ EXAMPLES
   $ springmicro init astro -n example
 ```
 
-_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.1/src/commands/init/index.ts)_
+_See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.2/src/commands/init/index.ts)_
 
 ## `springmicro init astro`
 
@@ -144,7 +144,7 @@ EXAMPLES
   $ springmicro init astro -n <project-name>
 ```
 
-_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.1/src/commands/init/astro.ts)_
+_See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.2.0-alpha.2/src/commands/init/astro.ts)_
 
 ## `springmicro plugins`
 

package/dist/commands/init/astro.js

@@ -1,7 +1,7 @@
 import { Command, Flags } from '@oclif/core';
 import fs from 'node:fs';
 import path from 'node:path';
-import { tailwindConfigMjs, globalsCSS, libUtils, componentsJSON } from '../../data/astro/index.js';
+import { tailwindConfigMjs, globalsCSS, libUtils, componentsJSON, readme } from '../../data/astro/index.js';
 import chalk from 'chalk';
 import { logStep } from '../../log/index.js';
 import { checkUnixShellAndSpawn } from '../../utils/shell.js';
@@ -34,6 +34,7 @@ export default class Astro extends Command {
         Astro.step = logStep('Manipulating project files.', Astro.step, Astro.totalSteps);
         const componentsJSONFilePath = path.join(name, 'components.json');
         const tsConfigFilePath = path.join(name, 'tsconfig.json');
+        const readmeFilePath = path.join(name, 'README.md');
         const tailwindConfigFilePath = path.join(name, 'tailwind.config.mjs');
         const globalsCSSFilePath = path.join(name, 'src', 'styles', 'global.css');
         const libUtilsPath = path.join(name, 'src', 'lib');
@@ -52,6 +53,8 @@ export default class Astro extends Command {
         };
         this.log('write to ' + chalk.cyan(tsConfigFilePath));
         fs.writeFileSync(tsConfigFilePath, JSON.stringify(tsConfig, null, 2));
+        this.log('write to ' + chalk.cyan(readmeFilePath));
+        fs.writeFileSync(readmeFilePath, readme(name));
         this.log('write to ' + chalk.cyan(tailwindConfigFilePath));
         fs.writeFileSync(tailwindConfigFilePath, tailwindConfigMjs);
         this.log('write to ' + chalk.cyan(componentsJSONFilePath));

package/dist/data/astro/index.d.ts

@@ -6,4 +6,11 @@ export declare const libUtils = "import { clsx, type ClassValue } from \"clsx\"\
  * only change is globals.css => global.css
  */
 export declare const componentsJSON = "{\n  \"$schema\": \"https://ui.shadcn.com/schema.json\",\n  \"style\": \"default\",\n  \"rsc\": false,\n  \"tsx\": true,\n  \"tailwind\": {\n    \"config\": \"tailwind.config.mjs\",\n    \"css\": \"./src/styles/global.css\",\n    \"baseColor\": \"slate\",\n    \"cssVariables\": true,\n    \"prefix\": \"\"\n  },\n  \"aliases\": {\n    \"components\": \"@/components\",\n    \"utils\": \"@/lib/utils\"\n  }\n}";
+/**
+ * custom auth config
+ */
 export declare const authConfigTs = "import { getAuthConfig } from \"@springmicro/auth\";\n\nexport default getAuthConfig({\n  casdoorEndpoint: import.meta.env.PUBLIC_CASDOOR_ENDPOINT,\n  clientId: import.meta.env.PUBLIC_CASDOOR_CLIENT_ID,\n  clientSecret: import.meta.env.CASDOOR_CLIENT_SECRET,\n});";
+/**
+ * custom README
+ */
+export declare const readme: (projectName: string) => string;

package/dist/data/astro/index.js

@@ -1,4 +1,4 @@
-// file content from https://ui.shadcn.com/docs/installation/manual
+// some file content from https://ui.shadcn.com/docs/installation/manual
 // unless otherwise specified
 // site last accessed 6/6/2024
 export const tailwindConfigMjs = `const { fontFamily } = require("tailwindcss/defaultTheme")
@@ -197,6 +197,9 @@ export const componentsJSON = `{
     "utils": "@/lib/utils"
   }
 }`;
+/**
+ * custom auth config
+ */
 export const authConfigTs = `import { getAuthConfig } from "@springmicro/auth";
 
 export default getAuthConfig({
@@ -204,3 +207,48 @@ export default getAuthConfig({
   clientId: import.meta.env.PUBLIC_CASDOOR_CLIENT_ID,
   clientSecret: import.meta.env.CASDOOR_CLIENT_SECRET,
 });`;
+/**
+ * custom README
+ */
+export const readme = (projectName) => `# ${projectName}
+
+[![SpringMicroHost Badge](https://img.shields.io/badge/Built%20by-springmicrohost-4f70ce.svg)](https://springmicrohost.com)
+
+This [Astro](https://astro.build/) project was generated with \`@springmicro/cli\` using the [Astro Starter Kit: Blog](https://github.com/withastro/astro/tree/main/examples/blog) template with some modifications.
+
+\`\`\`bash
+npm i -g @springmicro/cli
+springmicro init astro -n ${projectName}
+\`\`\`
+
+## Features
+
+- [tailwindcss](https://tailwindcss.com/) for CSS classes and theming.
+- [shadcn/ui](https://ui.shadcn.com/) for plug-and-play React components.
+- [Content Collections](https://docs.astro.build/en/guides/content-collections/) for blogs, newsletters, whatever you'd like.
+
+
+## Development
+
+Install [pnpm](https://pnpm.io/) if you haven't already.
+
+<details>
+<summary>Why pnpm?</summary>
+It's a preference of SpringMicroHost. It mostly boils down to faster install times and better dependency management. \`@springmicro/cli\` commands only support pnpm so far.
+</details>
+
+\`\`\`bash
+pnpm install
+pnpm run dev
+\`\`\`
+
+## Adding SpringMicro packages
+
+\`\`\`bash
+springmicro add auth
+\`\`\` 
+
+## Learn more
+
+Check out [our documentation](https://docs.springmicrohost.com).
+`;

package/oclif.manifest.json

@@ -101,5 +101,5 @@
       ]
     }
   },
-  "version": "0.2.0-alpha.1"
+  "version": "0.2.0-alpha.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@springmicro/cli",
   "description": "A new CLI generated with oclif",
-  "version": "0.2.0-alpha.1",
+  "version": "0.2.0-alpha.2",
   "author": "David Buckley",
   "private": false,
   "publishConfig": {
@@ -76,5 +76,5 @@
     "version": "oclif readme && git add README.md"
   },
   "types": "dist/index.d.ts",
-  "gitHead": "d988e7008130d071792f11d20bd22ab2fe4ea695"
+  "gitHead": "dbf0b4a9ec2e4023416638d4dcc6ac87e0d33d42"
 }