@popina/cli 5.0.0-20260203082304Z → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @popina/cli
 
+## 5.0.0
+
+### Major Changes
+
+- Rename @fveauvy/cli to @popina/cli.
+
+We now manage entirely publishing of our CLI.
+
+### Minor Changes
+
+- Migrate from @pragma/cli to @popina/cli package.
+
+### Patch Changes
+
+- Popina CLI generate command now uses turbo generators from packages/cli/turbo/ instead of turbo/.
+- Bump vitest config from 0.x.x to 4.0.17
+- Add metadata to Popina CLI package
+- Change package name to Popina CLI
+
 ## 4.5.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@popina/cli",
-  "version": "5.0.0-20260203082304Z",
+  "version": "5.0.0",
   "description": "Popina CLI",
   "repository": {
     "type": "git",
@@ -20,8 +20,8 @@
   "author": "François Veauvy",
   "devDependencies": {
     "eslint": "^9.19.0",
-    "@pragma/eslint": "1.3.4",
-    "@pragma/config": "2.21.0",
+    "@pragma/config": "3.0.0",
+    "@pragma/eslint": "1.3.5",
     "@pragma/tsconfig": "1.0.2"
   },
   "dependencies": {

package/turbo/generators/config.ts

@@ -0,0 +1,11 @@
+import type { PlopTypes } from '@turbo/gen'
+
+import { generatorApi } from './plopGenerator/api'
+import { generatorComponent } from './plopGenerator/component'
+import { generatorIcon } from './plopGenerator/icon'
+
+export default function generator(plop: PlopTypes.NodePlopAPI): void {
+  generatorComponent(plop)
+  generatorIcon(plop)
+  generatorApi(plop)
+}

package/turbo/generators/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/turbo/generators/plopGenerator/api.ts

@@ -0,0 +1,456 @@
+import fs from 'fs'
+import path from 'path'
+import type { PlopTypes } from '@turbo/gen'
+import pluralize from 'pluralize'
+
+type EndpointActionValues = {
+  actionName: string
+  entityName: string
+  zodElementarySchemaDefinition: string
+  zodSchemaDefinitionName: string
+  typeName: string
+  fastifySchemaName: string
+  fastifyDescription: string
+  fastifySummary: string
+  fastifyOperationId: string
+  verb: string
+  responseCode: number
+  route: string
+  isAParamRoute?: boolean
+}
+
+export const generatorApi = (plop: PlopTypes.NodePlopAPI) => {
+  plop.setGenerator('api', {
+    description: 'Create a new API endpoint',
+    prompts: [
+      {
+        type: 'list',
+        name: 'apiDirectory',
+        message:
+          'What is the new API directory in which you want to create the endpoint(s) ?',
+        choices: () => {
+          return fs
+            .readdirSync(path.join(plop.getDestBasePath(), '/apps/'))
+            .filter(
+              (f) =>
+                fs
+                  .statSync(path.join(plop.getDestBasePath() + '/apps/', f))
+                  .isDirectory() && f.startsWith('api'),
+            )
+            .map((f) => ({
+              name: f,
+              value: f,
+            }))
+        },
+      },
+      {
+        type: 'input',
+        name: 'modulePath',
+        message:
+          "What is the name of the new module to create the endpoints in ? (e.g: 'auth', 'v1/auth')",
+        validate: (input: string) => {
+          if (!input) {
+            return 'module name is required'
+          }
+
+          if (input.match(/^([a-zA-Z0-9]+)(\/[a-zA-Z0-9]+)*$/)) {
+            return true
+          } else {
+            return 'Malformed module name must only contain alphanumeric characters [a-zA-Z0-9] and slashes (no slashes at the beginning or end & at least one character between slashes)'
+          }
+        },
+      },
+      {
+        type: 'checkbox',
+        name: 'endpointActions',
+        message: 'What is the action(s) of the module ?',
+        choices: (inputs) => {
+          const entity = pluralize.singular(inputs.modulePath.split('/').pop())
+          const pluralEntity = pluralize.plural(entity)
+          const capitalizedEntity = entity[0].toUpperCase() + entity.slice(1)
+          const capitalizedPluralEntity =
+            pluralEntity[0].toUpperCase() + pluralEntity.slice(1)
+
+          return [
+            {
+              name: `getOne${capitalizedEntity}`,
+              value: {
+                actionName: `getOne${capitalizedEntity}`,
+                entityName: entity,
+                zodElementarySchemaDefinition: `fetch${capitalizedEntity}Output`,
+                zodSchemaDefinitionName: `fetch${capitalizedEntity}ReplySchema`,
+                typeName: `${capitalizedEntity}OutputType`,
+                fastifySchemaName: `fetch${capitalizedEntity}Schema`,
+                fastifyDescription: `Fetch one ${entity} based on the ${entity} id`,
+                fastifySummary: `fetch a ${entity}`,
+                fastifyOperationId: `fetch-${entity}`,
+                verb: 'get',
+                responseCode: 200,
+                route: '/:id',
+                isAParamRoute: true,
+              },
+            },
+            {
+              name: `getMany${capitalizedPluralEntity}`,
+              value: {
+                actionName: `getMany${capitalizedPluralEntity}`,
+                entityName: entity,
+                zodElementarySchemaDefinition: `fetch${capitalizedPluralEntity}ListOutput`,
+                zodSchemaDefinitionName: `fetch${capitalizedPluralEntity}ListReplySchema`,
+                typeName: `${capitalizedPluralEntity}ListOutputType`,
+                fastifySchemaName: `fetch${capitalizedPluralEntity}ListSchema`,
+                fastifyDescription: `Fetch many ${pluralEntity}`,
+                fastifySummary: `fetch a list of ${pluralEntity}`,
+                fastifyOperationId: `fetch-many-${pluralEntity}`,
+                verb: 'get',
+                responseCode: 200,
+                route: '/',
+              },
+            },
+            {
+              name: 'custom',
+              value: {
+                entityName: 'custom',
+              },
+            },
+          ]
+        },
+      },
+      {
+        when: (inputs) => {
+          return inputs.endpointActions.some(
+            (action: EndpointActionValues) => action.entityName === 'custom',
+          )
+        },
+        type: 'input',
+        name: 'customName',
+        message: 'What is the name of the custom endpoint ?',
+        validate(input, answers) {
+          if (!input) {
+            return 'custom endpoint name is required'
+          }
+
+          if (input.match(/^([a-zA-Z0-9]+)(\/[a-zA-Z0-9]+)*$/) && answers) {
+            answers.endpointActions.find((action: EndpointActionValues) => {
+              if (action.entityName === 'custom') {
+                action.actionName = input
+                action.entityName = answers.modulePath.split('/').pop()
+                action.zodElementarySchemaDefinition = input
+                action.zodSchemaDefinitionName = input + 'Schema'
+                action.typeName =
+                  input[0].toUpperCase() + input.slice(1) + 'Type'
+                action.fastifySchemaName = input + 'FastifySchema'
+                action.fastifyDescription =
+                  'Please set the description of the custom endpoint'
+                action.fastifySummary =
+                  'Please set the summary of the custom endpoint'
+                action.fastifyOperationId = input
+                action.verb = 'get'
+                action.responseCode = 200
+                action.route = '/'
+              }
+            })
+
+            console.log(answers.endpointActions)
+
+            return true
+          } else {
+            return 'Malformed custom endpoint name must only contain alphanumeric characters [a-zA-Z0-9] and slashes (no slashes at the beginning or end & at least one character between slashes)'
+          }
+        },
+      },
+    ],
+    actions: function (data) {
+      const entity = data?.modulePath.split('/').pop()
+      const actions: PlopTypes.Actions = [
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.schema.ts`,
+          templateFile: 'templates/api/api-schema.hbs',
+          abortOnFail: true,
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.router.ts`,
+          templateFile: 'templates/api/api-router.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.controller.ts`,
+          templateFile: 'templates/api/api-controller.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.service.ts`,
+          templateFile: 'templates/api/api-service.hbs',
+        },
+        {
+          type: 'modify',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+          pattern: /(?<=(import.*'\.\/modules.*schema')).*(?=(\n\n))/gm,
+          template: `\nimport { ${entity}Schemas } from './modules/{{modulePath}}/${entity}.schema'`,
+        },
+        {
+          type: 'modify',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+          pattern: /(?<=(for .* \[\n?))(((\s+)?\.{3}\w+(,?( |\r|)))+)/gm,
+          template: `\n    ...${entity}Schemas,\r$2`,
+        },
+      ]
+
+      data?.endpointActions.forEach((action: EndpointActionValues) => {
+        if (action.isAParamRoute) {
+          actions.push(
+            {
+              type: 'add',
+              path: `{{ turbo.paths.root }}/packages/common/server/schemas/params/${entity}.schema.ts`,
+              templateFile: 'templates/api/api-param-schema.hbs',
+            },
+            {
+              type: 'append',
+              path: `{{ turbo.paths.root }}/packages/common/server/schemas/params/index.ts`,
+              template: `export * from './${entity}.schema'`,
+            },
+            {
+              type: 'modify',
+              path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+              // ----- Append entityParamId schema to the common/server import block ----- //
+              pattern:
+                /(?<=(import {\n?))(.*)(?=((.*\n?( |,\n))*} from '@pragma\/common\/server'))/gm,
+              template: `\n  ${entity}IdParamSchema,\n$2`,
+            },
+            {
+              type: 'modify',
+              path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+              // ----- Export entityParamId schema to the common/server export block ----- //
+              pattern: /(?<=(for .* \[\n?))(((\s+)?\.{3}\w+(,?( |\r|)))+)/gm,
+              template: `\n    ...${entity}IdParamSchema,\r$2`,
+            },
+          )
+        }
+      })
+
+      return actions
+    },
+  })
+
+  plop.addHelper('getEntityFromPath', (path: string) => {
+    if (path.includes('/')) {
+      return path.split('/').pop()
+    }
+
+    return path
+  })
+
+  plop.setGenerator('api', {
+    description: 'Create a new API endpoint',
+    prompts: [
+      {
+        type: 'list',
+        name: 'apiDirectory',
+        message:
+          'What is the new API directory in which you want to create the endpoint(s) ?',
+        choices: () => {
+          return fs
+            .readdirSync(path.join(plop.getDestBasePath(), '/apps/'))
+            .filter(
+              (f) =>
+                fs
+                  .statSync(path.join(plop.getDestBasePath() + '/apps/', f))
+                  .isDirectory() && f.startsWith('api'),
+            )
+            .map((f) => ({
+              name: f,
+              value: f,
+            }))
+        },
+      },
+      {
+        type: 'input',
+        name: 'modulePath',
+        message:
+          "What is the name of the new module to create the endpoints in ? (e.g: 'auth', 'v1/auth')",
+        validate: (input: string) => {
+          if (!input) {
+            return 'module name is required'
+          }
+
+          if (input.match(/^([a-zA-Z0-9]+)(\/[a-zA-Z0-9]+)*$/)) {
+            return true
+          } else {
+            return 'Malformed module name must only contain alphanumeric characters [a-zA-Z0-9] and slashes (no slashes at the beginning or end & at least one character between slashes)'
+          }
+        },
+      },
+      {
+        type: 'checkbox',
+        name: 'endpointActions',
+        message: 'What is the action(s) of the module ?',
+        choices: (inputs) => {
+          const entity = pluralize.singular(inputs.modulePath.split('/').pop())
+          const pluralEntity = pluralize.plural(entity)
+          const capitalizedEntity = entity[0].toUpperCase() + entity.slice(1)
+          const capitalizedPluralEntity =
+            pluralEntity[0].toUpperCase() + pluralEntity.slice(1)
+
+          return [
+            {
+              name: `getOne${capitalizedEntity}`,
+              value: {
+                actionName: `getOne${capitalizedEntity}`,
+                entityName: entity,
+                zodElementarySchemaDefinition: `fetch${capitalizedEntity}Output`,
+                zodSchemaDefinitionName: `fetch${capitalizedEntity}ReplySchema`,
+                typeName: `${capitalizedEntity}OutputType`,
+                fastifySchemaName: `fetch${capitalizedEntity}Schema`,
+                fastifyDescription: `Fetch one ${entity} based on the ${entity} id`,
+                fastifySummary: `fetch a ${entity}`,
+                fastifyOperationId: `fetch-${entity}`,
+                verb: 'get',
+                responseCode: 200,
+                route: '/:id',
+                isAParamRoute: true,
+              },
+            },
+            {
+              name: `getMany${capitalizedPluralEntity}`,
+              value: {
+                actionName: `getMany${capitalizedPluralEntity}`,
+                entityName: entity,
+                zodElementarySchemaDefinition: `fetch${capitalizedPluralEntity}ListOutput`,
+                zodSchemaDefinitionName: `fetch${capitalizedPluralEntity}ListReplySchema`,
+                typeName: `${capitalizedPluralEntity}ListOutputType`,
+                fastifySchemaName: `fetch${capitalizedPluralEntity}ListSchema`,
+                fastifyDescription: `Fetch many ${pluralEntity}`,
+                fastifySummary: `fetch a list of ${pluralEntity}`,
+                fastifyOperationId: `fetch-many-${pluralEntity}`,
+                verb: 'get',
+                responseCode: 200,
+                route: '/',
+              },
+            },
+            {
+              name: 'custom',
+              value: {
+                entityName: 'custom',
+              },
+            },
+          ]
+        },
+      },
+      {
+        when: (inputs) => {
+          return inputs.endpointActions.some(
+            (action: EndpointActionValues) => action.entityName === 'custom',
+          )
+        },
+        type: 'input',
+        name: 'customName',
+        message: 'What is the name of the custom endpoint ?',
+        validate(input, answers) {
+          if (!input) {
+            return 'custom endpoint name is required'
+          }
+
+          if (input.match(/^([a-zA-Z0-9]+)(\/[a-zA-Z0-9]+)*$/) && answers) {
+            answers.endpointActions.find((action: EndpointActionValues) => {
+              if (action.entityName === 'custom') {
+                action.actionName = input
+                action.entityName = answers.modulePath.split('/').pop()
+                action.zodElementarySchemaDefinition = input
+                action.zodSchemaDefinitionName = input + 'Schema'
+                action.typeName =
+                  input[0].toUpperCase() + input.slice(1) + 'Type'
+                action.fastifySchemaName = input + 'FastifySchema'
+                action.fastifyDescription =
+                  'Please set the description of the custom endpoint'
+                action.fastifySummary =
+                  'Please set the summary of the custom endpoint'
+                action.fastifyOperationId = input
+                action.verb = 'get'
+                action.responseCode = 200
+                action.route = `/${input}`
+              }
+            })
+
+            return true
+          } else {
+            return 'Malformed custom endpoint name must only contain alphanumeric characters [a-zA-Z0-9] and slashes (no slashes at the beginning or end & at least one character between slashes)'
+          }
+        },
+      },
+    ],
+    actions: function (data) {
+      const entity = data?.modulePath.split('/').pop()
+      const actions: PlopTypes.Actions = [
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.schema.ts`,
+          templateFile: 'templates/api/api-schema.hbs',
+          abortOnFail: true,
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.router.ts`,
+          templateFile: 'templates/api/api-router.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.controller.ts`,
+          templateFile: 'templates/api/api-controller.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/modules/{{modulePath}}/${entity}.service.ts`,
+          templateFile: 'templates/api/api-service.hbs',
+        },
+        {
+          type: 'modify',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+          pattern: /(?<=(import.*'\.\/modules.*schema')).*(?=(\n\n))/gm,
+          template: `\nimport { ${entity}Schemas } from './modules/{{modulePath}}/${entity}.schema'`,
+        },
+        {
+          type: 'modify',
+          path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+          pattern: /(?<=(for .* \[\n?))(((\s+)?\.{3}\w+(,?( |\r|)))+)/gm,
+          template: `\n    ...${entity}Schemas,\r$2`,
+        },
+      ]
+
+      data?.endpointActions.forEach((action: EndpointActionValues) => {
+        if (action.isAParamRoute) {
+          actions.push(
+            {
+              type: 'add',
+              path: `{{ turbo.paths.root }}/packages/common/server/schemas/params/${entity}.schema.ts`,
+              templateFile: 'templates/api/api-param-schema.hbs',
+            },
+            {
+              type: 'append',
+              path: `{{ turbo.paths.root }}/packages/common/server/schemas/params/index.ts`,
+              template: `export * from './${entity}.schema'`,
+            },
+            {
+              type: 'modify',
+              path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+              // ----- Append entityParamId schema to the common/server import block ----- //
+              pattern:
+                /(?<=(import {))(\n?.*)(?=((.*\n?( |,\n))*} from '@pragma\/common\/server'))/gm,
+              template: `\n  ${entity}IdParamSchema,\n$2`,
+            },
+            {
+              type: 'modify',
+              path: `{{ turbo.paths.root }}/apps/{{apiDirectory}}/src/schemas.ts`,
+              // ----- Export entityParamId schema to the common/server export block ----- //
+              pattern: /(?<=(for .* \[\n?))(((\s+)?\.{3}\w+(,?( |\r|)))+)/gm,
+              template: `\n    ...${entity}IdParamSchema,\r$2`,
+            },
+          )
+        }
+      })
+
+      return actions
+    },
+  })
+}

package/turbo/generators/plopGenerator/component.ts

@@ -0,0 +1,63 @@
+import type { PlopTypes } from '@turbo/gen'
+
+export const generatorComponent = (plop: PlopTypes.NodePlopAPI) => {
+  plop.setGenerator('component', {
+    description: 'Create a new component in @pragma/ui',
+    prompts: [
+      {
+        type: 'input',
+        name: 'componentName',
+        message: 'What is the name of the new component to create?',
+        validate: (input) => {
+          if (input.includes('.')) {
+            return 'File name cannot include an extension.'
+          }
+          if (!input) {
+            return 'File name is required.'
+          }
+          return true
+        },
+      },
+    ],
+    actions: (data) => {
+      const componentName = data?.componentName
+      const camelCaseComponentName = plop.getHelper('camelCase')(componentName)
+
+      const pascalCaseComponentName =
+        plop.getHelper('pascalCase')(componentName)
+
+      const actions: PlopTypes.Actions = []
+
+      actions.push(
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/packages/ui/src/components/${camelCaseComponentName}/index.ts`,
+          templateFile: 'templates/component/component-index.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/packages/ui/src/components/${camelCaseComponentName}/${pascalCaseComponentName}.tsx`,
+          templateFile: 'templates/component/component-react.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/packages/ui/src/components/${camelCaseComponentName}/${camelCaseComponentName}.stories.tsx`,
+          templateFile: 'templates/component/component-story.hbs',
+        },
+        {
+          type: 'add',
+          path: `{{ turbo.paths.root }}/packages/ui/src/components/${camelCaseComponentName}/${camelCaseComponentName}.test.tsx`,
+          templateFile: 'templates/component/component-test.hbs',
+        },
+        {
+          type: 'modify',
+          path: '{{ turbo.paths.root }}/packages/ui/index.ts',
+          pattern: /export \{/,
+          template: `import { ${pascalCaseComponentName} } from './src/components/${camelCaseComponentName}/index';\n\nexport {\n  ${pascalCaseComponentName},`,
+        },
+      )
+
+      return actions
+    },
+  })
+}