stacks 0.1.0 → 0.37.3

package/src/cli/actions/generate.ts

@@ -0,0 +1,159 @@
+import consola from 'consola'
+import Prompts from 'prompts'
+import { runNpmScript } from '@stacksjs/helpers'
+import { ExitCode, NpmScript } from '@stacksjs/types'
+import { lintFix } from './lint'
+import { generateTypes } from './types'
+
+const { prompts } = Prompts
+
+export async function generateLibEntries() {
+  try {
+    await runNpmScript(NpmScript.GenerateEntries, 'ignore')
+    consola.success('Library entry points were generated successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error generating your library entry points.')
+    consola.error(error)
+  }
+}
+
+export async function generateVueCompat() {
+  try {
+    await runNpmScript(NpmScript.GenerateVueCompat, 'ignore')
+    consola.success('Vue 2 & 3 compatibility was generated successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error generating Vue compatibility.')
+    consola.error(error)
+  }
+}
+
+export async function generateWebTypes() {
+  try {
+    await runNpmScript(NpmScript.GenerateWebTypes, 'ignore')
+    consola.success('Successfully generated the web-types.json file.')
+  }
+  catch (error) {
+    consola.error('There was an error generating the web-types.json file')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function generateVsCodeCustomData() {
+  try {
+    await runNpmScript(NpmScript.GenerateVsCodeCustomData, 'ignore')
+    await lintFix('ignore') // the created json file needs to be linted
+    consola.success('Successfully generated the custom-elements.json file.')
+  }
+  catch (error) {
+    consola.error('There was an error generating the custom-elements.json file')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function generateIdeHelpers() {
+  try {
+    await runNpmScript(NpmScript.GenerateIdeHelpers, 'ignore')
+    await lintFix('ignore') // the created json file needs to be linted
+    consola.success('Successfully generated IDE helpers.')
+  }
+  catch (error) {
+    consola.error('There was an error generating IDE helpers.')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function generateComponentMeta() {
+  try {
+    await runNpmScript(NpmScript.GenerateComponentMeta, 'ignore')
+    await lintFix('ignore') // the created json file needs to be linted
+    consola.success('Successfully generated component meta.')
+  }
+  catch (error) {
+    consola.error('There was an error generating your component meta information.')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function startGenerationProcess(options: any) {
+  if (options.types || options === 'types') {
+    await generateTypes()
+  }
+
+  else if (options.entries || options === 'entries') {
+    await generateLibEntries()
+  }
+
+  else if (options.webTypes || options === 'web-types') {
+    await generateWebTypes()
+  }
+
+  else if (options.customData || options === 'custom-data') {
+    await generateVsCodeCustomData()
+  }
+
+  else if (options.ideHelpers || options === 'ide-helpers') {
+    await generateIdeHelpers()
+  }
+
+  else if (options.vueCompatibility || options === 'vue-compatibility') {
+    await generateVueCompat()
+  }
+
+  else if (options.componentMeta || options === 'component-meta') {
+    await generateComponentMeta()
+  }
+
+  else {
+    const answer = await prompts.select({
+      type: 'select',
+      name: 'generate',
+      message: 'What are you trying to generate?',
+      choices: [ // todo: should be a multi-select
+        { title: '1.) TypeScript Types', value: 'types' },
+        { title: '2.) Library Entry Points', value: 'entries' },
+        { title: '3.) Web Types', value: 'web-types' },
+        { title: '4.) VS Code Custom Data', value: 'custom-data' },
+        { title: '5.) IDE Helpers', value: 'ide-helpers' },
+        { title: '6.) Vue 2 & 3 Compatibility', value: 'vue-compatibility' },
+        { title: '7.) Component Meta', value: 'component-meta' },
+      ],
+      initial: 0,
+    })
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'types')
+      await generateTypes()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'entries')
+      await generateLibEntries()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'web-types')
+      await generateWebTypes()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'custom-data')
+      await generateVsCodeCustomData()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'ide-helpers')
+      await generateIdeHelpers()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'vue-compatibility')
+      await generateVueCompat()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'component-meta')
+      await generateComponentMeta()
+
+    else process.exit(ExitCode.InvalidArgument)
+  }
+}

package/src/cli/actions/index.ts

@@ -0,0 +1,12 @@
+export * from './build'
+export * from './commit'
+export * from './dev'
+export * from './examples'
+export * from './fresh'
+export * from './generate'
+export * from './key'
+export * from './lint'
+export * from './make'
+export * from './release'
+export * from './test'
+export * from './update'

package/src/cli/actions/key.ts

@@ -0,0 +1,31 @@
+import { getRandomValues } from 'node:crypto'
+import consola from 'consola'
+import ezSpawn from '@jsdevtools/ez-spawn'
+// import { generateAppKey } from '@stacksjs/security'
+import { projectPath } from '@stacksjs/paths'
+import { setEnvValue } from '@stacksjs/helpers'
+import { isFile } from '@stacksjs/fs'
+import utf8 from 'crypto-js/enc-utf8'
+import base64 from 'crypto-js/enc-base64'
+
+export async function generateAppKey() {
+  const random = getRandomValues(new Uint8Array(32))
+  const encodedWord = utf8.parse(random.toString())
+  const key = base64.stringify(encodedWord)
+
+  return `base64:${key}`
+}
+
+export async function generate() {
+  consola.info('Setting random application key.')
+
+  // if the .env file does not exist, ensure it is created
+  if (!isFile('.env'))
+    await ezSpawn.async('cp .env.example .env', { stdio: 'inherit', cwd: projectPath() })
+
+  await setEnvValue('APP_KEY', await generateAppKey())
+
+  consola.success('Application key set.')
+
+  return true
+}

package/src/cli/actions/lint.ts

@@ -0,0 +1,19 @@
+import consola from 'consola'
+import { runNpmScript } from '@stacksjs/helpers'
+import { NpmScript } from '@stacksjs/types'
+
+export async function lint(debug: 'ignore' | 'inherit' = 'inherit') {
+  consola.info('Linting your codebase...')
+  await runNpmScript(NpmScript.Lint, debug)
+  consola.success('Successfully linted your codebase.')
+}
+
+export async function lintFix(debug: 'ignore' | 'inherit' = 'inherit') {
+  if (debug !== 'ignore')
+    consola.info('Fixing lint errors...')
+
+  await runNpmScript(NpmScript.LintFix, debug)
+
+  if (debug !== 'ignore')
+    consola.success('Fixed lint errors.')
+}

package/src/cli/actions/make.ts

@@ -0,0 +1,116 @@
+import consola from 'consola'
+import * as ezSpawn from '@jsdevtools/ez-spawn'
+import { writeTextFile } from '@stacksjs/fs'
+import { resolve } from '@stacksjs/paths'
+
+export async function component(name: string) {
+  consola.info('Creating your component...')
+
+  try {
+    await writeTextFile({
+      path: `./components/${name}.vue`,
+      data: `<script setup lang="ts">
+// eslint-disable-next-line no-console
+console.log('Hello World component created')
+</script>
+
+<template>
+  <div>
+    Some HTML block
+  </div>
+</template>
+`,
+    })
+
+    consola.success(`Created the ${name} component.`)
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}
+
+export async function page(name: string) {
+  consola.info('Creating your component...')
+
+  try {
+    await writeTextFile({
+      path: `./pages/${name}.vue`,
+      data: `<script setup lang="ts">
+// eslint-disable-next-line no-console
+console.log('Hello World page created')
+</script>
+
+<template>
+  <div>
+    Visit http://127.0.0.1/${name}
+  </div>
+</template>
+`,
+    })
+
+    consola.success(`Created the ${name} page.`)
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}
+
+export async function fx(name: string) {
+  consola.info('Creating your function...')
+
+  try {
+    await writeTextFile({
+      path: `./functions/${name}.ts`,
+      data: `// reactive state
+const ${name} = ref(0)
+
+// functions that mutate state and trigger updates
+function increment() {
+  ${name}.value++
+}
+
+export {
+  ${name},
+  increment,
+}
+`,
+    })
+
+    consola.success(`Created the ${name} function.`)
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}
+
+export async function language(language: string) {
+  consola.info('Creating your translation file...')
+
+  try {
+    await writeTextFile({
+      path: `./lang/${language}.yml`,
+      data: `button:
+  text: Copy
+`,
+    })
+
+    consola.success(`Created the ${language} translation file.`)
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}
+
+export async function stack(name: string) {
+  consola.info('Creating your stack...')
+
+  try {
+    const path = resolve(process.cwd(), name)
+    await ezSpawn.async(`giget stacks ${path}`)
+    consola.success('Successfully scaffolded your project.')
+    consola.info(`cd ${path} && pnpm install`)
+  }
+  catch (err) {
+    consola.error(err)
+  }
+}

package/src/cli/actions/release.ts

@@ -0,0 +1,9 @@
+import consola from 'consola'
+import { runNpmScript } from '@stacksjs/helpers'
+import { NpmScript } from '@stacksjs/types'
+
+export async function release() {
+  consola.info('Releasing...')
+  await runNpmScript(NpmScript.Release)
+  consola.success('Triggered release workflow')
+}

package/src/cli/actions/test.ts

@@ -0,0 +1,39 @@
+import consola from 'consola'
+import { runNpmScript } from '@stacksjs/helpers'
+import { NpmScript } from '@stacksjs/types'
+
+export async function typecheck() {
+  consola.info('Typechecking your codebase...')
+
+  try {
+    await runNpmScript(NpmScript.TestTypes)
+    consola.success('Finished typechecking your codebase.')
+  }
+  catch (error) {
+    consola.error(error)
+  }
+}
+
+export async function runTestSuite() {
+  consola.info('Running your test suite...')
+
+  try {
+    await runNpmScript(NpmScript.Test)
+    consola.success('Completed running the test suite.')
+  }
+  catch (error) {
+    consola.error(error)
+  }
+}
+
+export async function generateTestCoverageReport() {
+  consola.info('Generating a test coverage report...')
+
+  try {
+    await runNpmScript(NpmScript.TestCoverage)
+    consola.success('Generated the test coverage report.')
+  }
+  catch (error) {
+    consola.error(error)
+  }
+}

package/src/cli/actions/types.ts

@@ -0,0 +1,180 @@
+import consola from 'consola'
+import Prompts from 'prompts'
+import { runNpmScript } from '@stacksjs/helpers'
+import { ExitCode, NpmScript } from '@stacksjs/types'
+import { lintFix } from './lint'
+
+const { prompts } = Prompts
+
+export async function generateTypes() {
+  try {
+    await runNpmScript(NpmScript.TypesGenerate, 'ignore')
+    consola.success('Types were generated successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error generating your types.')
+    consola.error(error)
+  }
+}
+
+export async function fixTypes() {
+  try {
+    await runNpmScript(NpmScript.TypesFix, 'ignore')
+    consola.success('Types were generated successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error generating your types.')
+    consola.error(error)
+  }
+}
+
+export async function generateLibEntries() {
+  try {
+    await runNpmScript(NpmScript.GenerateEntries, 'ignore')
+    consola.success('Library entry points were generated successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error generating your library entry points.')
+    consola.error(error)
+  }
+}
+
+export async function generateVueCompat() {
+  try {
+    await runNpmScript(NpmScript.GenerateVueCompat, 'ignore')
+    consola.success('Vue 2 & 3 compatibility was generated successfully.')
+  }
+  catch (error) {
+    consola.error('There was an error generating Vue compatibility.')
+    consola.error(error)
+  }
+}
+
+export async function generateWebTypes() {
+  try {
+    await runNpmScript(NpmScript.GenerateWebTypes, 'ignore')
+    consola.success('Successfully generated the web-types.json file.')
+  }
+  catch (error) {
+    consola.error('There was an error generating the web-types.json file')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function generateVsCodeCustomData() {
+  try {
+    await runNpmScript(NpmScript.GenerateVsCodeCustomData, 'ignore')
+    await lintFix('ignore') // the created json file needs to be linted
+    consola.success('Successfully generated the custom-elements.json file.')
+  }
+  catch (error) {
+    consola.error('There was an error generating the custom-elements.json file')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function generateIdeHelpers() {
+  try {
+    await runNpmScript(NpmScript.GenerateIdeHelpers, 'ignore')
+    await lintFix('ignore') // the created json file needs to be linted
+    consola.success('Successfully generated IDE helpers.')
+  }
+  catch (error) {
+    consola.error('There was an error generating IDE helpers.')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function generateComponentMeta() {
+  try {
+    await runNpmScript(NpmScript.GenerateComponentMeta, 'ignore')
+    await lintFix('ignore') // the created json file needs to be linted
+    consola.success('Successfully generated component meta.')
+  }
+  catch (error) {
+    consola.error('There was an error generating your component meta information.')
+    consola.error(error)
+    process.exit(ExitCode.FatalError)
+  }
+}
+
+export async function startGenerationProcess(options: any) {
+  if (options.types || options === 'types') {
+    await generateTypes()
+  }
+
+  else if (options.entries || options === 'entries') {
+    await generateLibEntries()
+  }
+
+  else if (options.webTypes || options === 'web-types') {
+    await generateWebTypes()
+  }
+
+  else if (options.customData || options === 'custom-data') {
+    await generateVsCodeCustomData()
+  }
+
+  else if (options.ideHelpers || options === 'ide-helpers') {
+    await generateIdeHelpers()
+  }
+
+  else if (options.vueCompatibility || options === 'vue-compatibility') {
+    await generateVueCompat()
+  }
+
+  else if (options.componentMeta || options === 'component-meta') {
+    await generateComponentMeta()
+  }
+
+  else {
+    const answer = await prompts.select({
+      type: 'select',
+      name: 'generate',
+      message: 'What are you trying to generate?',
+      choices: [ // todo: should be a multi-select
+        { title: '1.) TypeScript Types', value: 'types' },
+        { title: '2.) Library Entry Points', value: 'entries' },
+        { title: '3.) Web Types', value: 'web-types' },
+        { title: '4.) VS Code Custom Data', value: 'custom-data' },
+        { title: '5.) IDE Helpers', value: 'ide-helpers' },
+        { title: '6.) Vue 2 & 3 Compatibility', value: 'vue-compatibility' },
+        { title: '7.) Component Meta', value: 'component-meta' },
+      ],
+      initial: 0,
+    })
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    if (answer === 'types')
+      await generateTypes()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'entries')
+      await generateLibEntries()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'web-types')
+      await generateWebTypes()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'custom-data')
+      await generateVsCodeCustomData()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'ide-helpers')
+      await generateIdeHelpers()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'vue-compatibility')
+      await generateVueCompat()
+
+    // @ts-expect-error the answer object type expects to return a void type but it returns a string
+    else if (answer === 'component-meta')
+      await generateComponentMeta()
+
+    else process.exit(ExitCode.InvalidArgument)
+  }
+}

package/src/cli/actions/update.ts

@@ -0,0 +1,90 @@
+import * as ezSpawn from '@jsdevtools/ez-spawn'
+import consola from 'consola'
+import Prompts from 'prompts'
+import { copyFolder, deleteEmptyFolders, deleteFiles, deleteFolder, doesFolderExist } from '@stacksjs/fs'
+import { resolve } from '@stacksjs/paths'
+import { runNpmScript } from '@stacksjs/helpers'
+import { ExitCode, NpmScript } from '@stacksjs/types'
+
+const { prompts } = Prompts
+
+export async function stacks(options: any) {
+  // first, we need to update the framework, if updates available
+  // TODO: need to delete all files except the whitelisted ones
+  if (options.framework) {
+    try {
+      // check if the .stacks folder has any updates
+      // https://carlosbecker.com/posts/git-changed/
+      await ezSpawn.async('git diff --quiet HEAD -- ./.stacks', { stdio: 'inherit', cwd: process.cwd() })
+    }
+    catch (error: any) {
+      if (error.status === 1) {
+        // even though the ./.stacks folder should not be edited, instead config values should be adjusted,
+        // there is a chance that users may apply local core edits, as it's totally acceptable, as long as
+        // the user knows what they are doing. There is also a change that simply the deps within .stacks
+        // folder have been updated and that could produce a diff.
+        if (!options.force) {
+          const answer = await prompts.confirm({
+            type: 'select',
+            name: 'framework-update',
+            message: 'Would you like to overwrite your ./stacks changes in favor of the Stacks update?',
+          })
+
+          // @ts-expect-error the answer object type expects to return a void type but it returns boolean
+          if (!answer) {
+            consola.info('The framework was not updated.')
+            consola.info('Note: if you commit your changes and replay the update, you will see what has changed.')
+            process.exit(ExitCode.Success)
+          }
+        }
+      }
+    }
+
+    consola.info('Downloading framework updates...')
+
+    const tempFolderName = 'updates'
+    const tempUpdatePath = resolve(process.cwd(), tempFolderName)
+    if (doesFolderExist(tempUpdatePath))
+      await deleteFolder(tempUpdatePath)
+
+    await ezSpawn.async(`giget stacks ${tempFolderName}`, { stdio: options.debug ? 'inherit' : 'ignore' }) // TODO: stdio should inherit when APP_DEBUG or debug flag is true
+    consola.success('Downloaded framework updates.')
+
+    consola.info('Updating framework...')
+
+    const frameworkPath = resolve(process.cwd(), '.stacks')
+    const exclude = ['functions/package.json', 'vue-components/package.json', 'web-components/package.json', 'auto-imports.d.ts', 'components.d.ts', 'dist']
+
+    await deleteFiles(frameworkPath, exclude)
+
+    // loop 5 times to make sure all "deep empty" folders are deleted
+    for (let i = 0; i < 5; i++)
+      await deleteEmptyFolders(frameworkPath)
+
+    const from = resolve(process.cwd(), './updates/.stacks')
+    const to = frameworkPath
+    await copyFolder(from, to, exclude)
+
+    consola.info('Cleanup...')
+    await deleteFolder(tempUpdatePath)
+    consola.success('Framework updated.')
+  }
+
+  // then, we need to update the project's & framework's dependencies, if updates available
+  if (options.dependencies) {
+    consola.info('Updating dependencies...')
+    await runNpmScript(NpmScript.Update)
+    consola.success('Updated dependencies.')
+  }
+
+  if (options.packageManager) {
+    consola.info('Updating pnpm...')
+    const version = await runNpmScript(NpmScript.UpdatePackageManager)
+    consola.success('Successfully updated pnpm to: ', version)
+  }
+
+  // TODO: also update CI files & configurations, and other files, possibly
+  // ideally we want this to be smart enough to update only the files that have changed
+
+  // TODO: this script should trigger regeneration of auto-imports.d.ts & components.d.ts
+}