fix(generators): Move generators and CLI to featherscloud/pinion (#3386)

feathersjs · Jan 22, 2024 · eb87c99 · eb87c99
1 parent 59fb40b
commit eb87c99
Show file tree

Hide file tree

Showing 58 changed files with 9,226 additions and 11,013 deletions.
diff --git a/generators/package.ts b/generators/package.ts
@@ -1,5 +1,5 @@
-import type { Callable, PinionContext } from '@feathershq/pinion'
-import { generator, install, prompt, runGenerators, toFile } from '@feathershq/pinion'
+import type { Callable, PinionContext } from '@featherscloud/pinion'
+import { generator, install, prompt, runGenerators, toFile } from '@featherscloud/pinion'
 
 export interface ModuleContext extends PinionContext {
   name: string

diff --git a/generators/package/index.tpl.ts b/generators/package/index.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, renderTemplate, toFile } from '@feathershq/pinion'
+import { generator, renderTemplate, toFile } from '@featherscloud/pinion'
 import { ModuleContext } from '../package'
 
 interface Context extends ModuleContext {}

diff --git a/generators/package/license.tpl.ts b/generators/package/license.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, renderTemplate, toFile } from '@feathershq/pinion'
+import { generator, renderTemplate, toFile } from '@featherscloud/pinion'
 import { ModuleContext } from '../package'
 
 interface Context extends ModuleContext {}

diff --git a/generators/package/package.json.tpl.ts b/generators/package/package.json.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, toFile, writeJSON } from '@feathershq/pinion'
+import { generator, toFile, writeJSON } from '@featherscloud/pinion'
 import { ModuleContext } from '../package'
 
 interface Context extends ModuleContext {}

diff --git a/generators/package/readme.md.tpl.ts b/generators/package/readme.md.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, renderTemplate, toFile } from '@feathershq/pinion'
+import { generator, renderTemplate, toFile } from '@featherscloud/pinion'
 import { ModuleContext } from '../package'
 
 const template = ({ description, moduleName }: ModuleContext) => `# ${moduleName}

diff --git a/generators/package/test.tpl.ts b/generators/package/test.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, renderTemplate, toFile } from '@feathershq/pinion'
+import { generator, renderTemplate, toFile } from '@featherscloud/pinion'
 import { ModuleContext } from '../package'
 
 interface Context extends ModuleContext {}

diff --git a/generators/package/tsconfig.json.tpl.ts b/generators/package/tsconfig.json.tpl.ts
@@ -1,4 +1,4 @@
-import { generator, toFile, writeJSON } from '@feathershq/pinion'
+import { generator, toFile, writeJSON } from '@featherscloud/pinion'
 import { ModuleContext } from '../package'
 
 export const generate = (context: ModuleContext) =>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,14 +38,14 @@
     "lint": "npm run prettier && npm run eslint",
     "compile": "lerna run compile",
     "build:docs": "npm run build --workspace docs",
-    "update-dependencies": "ncu -u && npm exec --workspaces -- ncu -u --dep prod,dev,optional,peer -x node-fetch,chalk,\"@sinclair/typebox\"",
+    "update-dependencies": "ncu -u && npm exec --workspaces -- ncu -u --dep prod,dev,optional,peer -x node-fetch,\"@sinclair/typebox\"",
     "clean": "find . -name node_modules -exec rm -rf '{}' + && find . -name package-lock.json -exec rm -rf '{}' +",
     "test:deno": "deno test --config deno/tsconfig.json deno/test.ts",
     "test": "npm run lint && npm run compile && c8 lerna run test --ignore @feathersjs/tests",
     "generate:package": "pinion run generators/package.ts"
   },
   "devDependencies": {
-    "@feathershq/pinion": "^0.4.0-pre.3",
+    "@featherscloud/pinion": "^0.5.0",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",
     "c8": "^9.1.0",

diff --git a/packages/cli/bin/feathers b/packages/cli/bin/feathers
@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 'use strict'
 
-const { program } = require('../lib')
+import { program } from '../lib/index.js'
 
 program.parse()
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -3,7 +3,8 @@
   "description": "The command line interface for creating Feathers applications",
   "version": "5.0.14",
   "homepage": "https://feathersjs.com",
-  "main": "lib/",
+  "main": "lib/index.js",
+  "type": "module",
   "bin": {
     "feathers": "./bin/feathers"
   },
@@ -45,15 +46,15 @@
   "scripts": {
     "prepublish": "npm run compile",
     "compile": "shx rm -rf lib/ && tsc",
-    "mocha": "mocha --timeout 60000 --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts",
+    "mocha": "mocha --timeout 60000 --config ../../.mocharc.json --require tsx --recursive test/**.test.ts test/**/*.test.ts",
     "test": "npm run compile && npm run mocha"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
     "@feathersjs/generators": "^5.0.14",
-    "chalk": "^4.0.1",
+    "chalk": "^5.3.0",
     "commander": "^11.1.0"
   },
   "devDependencies": {

diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -1,7 +1,7 @@
 import chalk from 'chalk'
 import { Command } from 'commander'
 import { dirname } from 'path'
-import { generator, runGenerator, getContext, FeathersBaseContext, version } from '@feathersjs/generators'
+import { runGenerator, getContext, FeathersBaseContext, version } from '@feathersjs/generators'
 
 export * from 'commander'
 export { chalk }
@@ -12,7 +12,7 @@ export const commandRunner = (name: string) => async (options: any) => {
     ...options
   })
 
-  await generator(ctx)
+  await Promise.resolve(ctx)
     .then(runGenerator(folder, name, 'index'))
     .catch((error) => {
       const { logger } = ctx.pinion

diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json
@@ -5,6 +5,7 @@
   ],
   "compilerOptions": {
     "outDir": "lib",
-    "resolveJsonModule": true
+    "module": "ESNext",
+    "moduleResolution": "Node"
   }
 }
diff --git a/packages/generators/package.json b/packages/generators/package.json
@@ -29,8 +29,9 @@
   "engines": {
     "node": ">= 16"
   },
-  "main": "lib/",
+  "main": "lib/index.js",
   "types": "lib/",
+  "type": "module",
   "files": [
     "CHANGELOG.md",
     "LICENSE",
@@ -43,7 +44,7 @@
   "scripts": {
     "prepublish": "npm run compile",
     "compile": "shx rm -rf lib/ && tsc && shx cp -r src/. lib/",
-    "test": "npm run compile && mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts"
+    "test": "npm run compile && mocha --config ../../.mocharc.json --require tsx --recursive test/**.test.ts test/**/*.test.ts"
   },
   "directories": {
     "lib": "lib"
@@ -52,8 +53,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathershq/pinion": "^0.3.5",
-    "chalk": "^4.0.1",
+    "@featherscloud/pinion": "^0.5.0",
+    "chalk": "^5.3.0",
     "lodash": "^4.17.21",
     "prettier": "^3.2.4",
     "typescript": "^5.3.3"
@@ -88,7 +89,7 @@
     "pg": "^8.11.3",
     "shx": "^0.3.4",
     "sqlite3": "^5.1.7",
-    "ts-node": "^10.9.2",
+    "tsx": "^4.7.0",
     "type-fest": "^4.9.0",
     "typescript": "^5.3.3"
   },

diff --git a/packages/generators/src/app/index.ts b/packages/generators/src/app/index.ts
@@ -1,8 +1,17 @@
-import { sep } from 'path'
+import { sep, dirname } from 'path'
 import chalk from 'chalk'
-import { generator, prompt, runGenerators, fromFile, install, copyFiles, toFile } from '@feathershq/pinion'
-import { FeathersBaseContext, FeathersAppInfo, initializeBaseContext, addVersions } from '../commons'
-import { generate as connectionGenerator, prompts as connectionPrompts } from '../connection'
+import { prompt, runGenerators, fromFile, copyFiles, toFile } from '@featherscloud/pinion'
+import {
+  FeathersBaseContext,
+  FeathersAppInfo,
+  initializeBaseContext,
+  addVersions,
+  install
+} from '../commons.js'
+import { generate as connectionGenerator, prompts as connectionPrompts } from '../connection/index.js'
+
+// Set __dirname in es module
+const __dirname = dirname(new URL(import.meta.url).pathname)
 
 export interface AppGeneratorData extends FeathersAppInfo {
   /**
@@ -36,15 +45,15 @@ export type AppGeneratorContext = FeathersBaseContext &
 export type AppGeneratorArguments = FeathersBaseContext & Partial<AppGeneratorData>
 
 export const generate = (ctx: AppGeneratorArguments) =>
-  generator(ctx)
+  Promise.resolve(ctx)
     .then(initializeBaseContext())
     .then((ctx) => ({
       ...ctx,
       dependencies: [],
       devDependencies: []
     }))
     .then(
-      prompt<AppGeneratorArguments, AppGeneratorContext>((ctx) => [
+      prompt((ctx) => [
         {
           name: 'language',
           type: 'list',
@@ -142,7 +151,7 @@ export const generate = (ctx: AppGeneratorArguments) =>
       }
     })
     .then(
-      install<AppGeneratorContext>(
+      install(
         ({ transports, framework, dependencyVersions, dependencies, schema }) => {
           const hasSocketio = transports.includes('websockets')
 
@@ -181,7 +190,7 @@ export const generate = (ctx: AppGeneratorArguments) =>
       )
     )
     .then(
-      install<AppGeneratorContext>(
+      install(
         ({ language, devDependencies, dependencyVersions }) => {
           devDependencies.push(
             'nodemon',

diff --git a/packages/generators/src/app/templates/app.test.tpl.ts b/packages/generators/src/app/templates/app.test.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({
   lib
@@ -47,4 +47,4 @@ describe('Feathers application tests', () => {
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(renderSource(template, toFile('test', 'app.test')))
+  Promise.resolve(ctx).then(renderSource(template, toFile('test', 'app.test')))
diff --git a/packages/generators/src/app/templates/app.tpl.ts b/packages/generators/src/app/templates/app.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const tsKoaApp = ({
   transports,
@@ -133,7 +133,7 @@ const template = (ctx: AppGeneratorContext) =>
   ctx.framework === 'express' ? tsExpressApp(ctx) : tsKoaApp(ctx)
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(
+  Promise.resolve(ctx).then(
     renderSource(
       template,
       toFile<AppGeneratorContext>(({ lib }) => lib, 'app')

diff --git a/packages/generators/src/app/templates/channels.tpl.ts b/packages/generators/src/app/templates/channels.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile, when } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile, when } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({
   language
@@ -43,7 +43,7 @@ export const channels = (app: Application) => {
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(
+  Promise.resolve(ctx).then(
     when<AppGeneratorContext>(
       ({ transports }) => transports.includes('websockets'),
       renderSource(

diff --git a/packages/generators/src/app/templates/client.test.tpl.ts b/packages/generators/src/app/templates/client.test.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile, when } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile, when } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({ lib }: AppGeneratorContext) => /* ts */ `import assert from 'assert'
 import axios from 'axios'
@@ -23,6 +23,6 @@ describe('client tests', () => {
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(
+  Promise.resolve(ctx).then(
     when<AppGeneratorContext>((ctx) => ctx.client, renderSource(template, toFile('test', 'client.test')))
   )
diff --git a/packages/generators/src/app/templates/client.tpl.ts b/packages/generators/src/app/templates/client.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile, when } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile, when } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({
   name,
@@ -42,7 +42,7 @@ export const createClient = <Configuration = any> (
 `
 
 export const generate = async (ctx: AppGeneratorContext) =>
-  generator(ctx).then(
+  Promise.resolve(ctx).then(
     when<AppGeneratorContext>(
       (ctx) => ctx.client,
       renderSource(

diff --git a/packages/generators/src/app/templates/configuration.tpl.ts b/packages/generators/src/app/templates/configuration.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile, when, writeJSON } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile, when, writeJSON } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const defaultConfig = ({}: AppGeneratorContext) => ({
   host: 'localhost',
@@ -73,7 +73,7 @@ export const configurationValidator = getValidator(configurationSchema, dataVali
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx)
+  Promise.resolve(ctx)
     .then(writeJSON(defaultConfig, toFile('config', 'default.json')))
     .then(writeJSON(testConfig, toFile('config', 'test.json')))
     .then(writeJSON(customEnvironment, toFile('config', 'custom-environment-variables.json')))

diff --git a/packages/generators/src/app/templates/declarations.tpl.ts b/packages/generators/src/app/templates/declarations.tpl.ts
@@ -1,5 +1,5 @@
-import { generator, toFile, when, renderTemplate } from '@feathershq/pinion'
-import { AppGeneratorContext } from '../index'
+import { toFile, when, renderTemplate } from '@featherscloud/pinion'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({
   framework,
@@ -31,7 +31,7 @@ export type HookContext<S = any> = FeathersHookContext<Application, S>
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(
+  Promise.resolve(ctx).then(
     when<AppGeneratorContext>(
       ({ language }) => language === 'ts',
       renderTemplate(

diff --git a/packages/generators/src/app/templates/index.html.tpl.ts b/packages/generators/src/app/templates/index.html.tpl.ts
@@ -1,5 +1,5 @@
-import { generator, renderTemplate, toFile } from '@feathershq/pinion'
-import { AppGeneratorContext } from '../index'
+import { renderTemplate, toFile } from '@featherscloud/pinion'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({ name, description }: AppGeneratorContext) => /* html */ `<!DOCTYPE html>
 <html lang="en">
@@ -41,4 +41,4 @@ const template = ({ name, description }: AppGeneratorContext) => /* html */ `<!D
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(renderTemplate(template, toFile('public', 'index.html')))
+  Promise.resolve(ctx).then(renderTemplate(template, toFile('public', 'index.html')))
diff --git a/packages/generators/src/app/templates/index.tpl.ts b/packages/generators/src/app/templates/index.tpl.ts
@@ -1,6 +1,6 @@
-import { generator, toFile } from '@feathershq/pinion'
-import { renderSource } from '../../commons'
-import { AppGeneratorContext } from '../index'
+import { toFile } from '@featherscloud/pinion'
+import { renderSource } from '../../commons.js'
+import { AppGeneratorContext } from '../index.js'
 
 const template = ({}: AppGeneratorContext) => /* ts */ `import { app } from './app'
 import { logger } from './logger'
@@ -18,7 +18,7 @@ app.listen(port).then(() => {
 `
 
 export const generate = (ctx: AppGeneratorContext) =>
-  generator(ctx).then(
+  Promise.resolve(ctx).then(
     renderSource(
       template,
       toFile<AppGeneratorContext>(({ lib }) => lib, 'index')