@gasket/preset-api 7.0.0-next.5 → 7.0.0-next.50

package/README.md

@@ -2,18 +2,10 @@
 
 Framework for building API's using Gasket.
 
-## Usage
-
-This preset requires v5 of the `@gasket/cli`:
-
-```bash
-npm i -g @gasket/cli@^5.0.0
-```
-
 ## Installation
 
 ```bash
-gasket create <app-name> --presets @gasket/preset-api
+npx create-gasket-app <app-name> --presets @gasket/preset-api
 ```
 
 ## Docs
@@ -22,7 +14,7 @@ To see complete the list of plugins configured in your app, and what commands, l
 
 ## Plugins
 
-- [@gasket/plugin-response-data](/packages/gasket-plugin-response-data/README.md)
+- [@gasket/plugin-data](/packages/gasket-plugin-data/README.md)
 - [@gasket/plugin-swagger](/packages/gasket-plugin-swagger/README.md)
 - [@gasket/plugin-docs](/packages/gasket-plugin-docs/README.md)
 - [@gasket/plugin-docusaurus](/packages/gasket-plugin-docusaurus/README.md)

package/generator/server.js

@@ -0,0 +1,2 @@
+import gasket from './gasket.js';
+gasket.actions.startServer();

package/lib/create.js

@@ -0,0 +1,29 @@
+import path from 'path';
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+const require = createRequire(import.meta.url);
+const { devDependencies } = require('../package.json');
+
+/**
+ * createHook
+ * @param {Gasket} gasket - Gasket API
+ * @param {Create} context - Create context
+ */
+export default function create(gasket, context) {
+  const { pkg, files } = context;
+  const __dirname = fileURLToPath(import.meta.url);
+  const generatorDir = path.join(__dirname, '..', '..', 'generator');
+
+  if (!context.typescript) {
+    files.add(`${generatorDir}/*`);
+
+    pkg.add('devDependencies', {
+      nodemon: devDependencies.nodemon
+    });
+
+    pkg.add('scripts', {
+      start: 'node server.js',
+      local: 'GASKET_ENV=local nodemon server.js'
+    });
+  }
+}

package/lib/index.d.ts

@@ -1,9 +1,7 @@
-import '@gasket/plugin-response-data';
-import '@gasket/plugin-docs';
-import '@gasket/plugin-docusaurus';
+import '@gasket/plugin-data';
 import '@gasket/plugin-express';
+import '@gasket/plugin-fastify';
 import '@gasket/plugin-https';
 import '@gasket/plugin-lint';
-import '@gasket/plugin-start';
 import '@gasket/plugin-swagger';
-import '@gasket/plugin-winston';
+import '@gasket/plugin-winston';

package/lib/index.js

@@ -1,77 +1,18 @@
-import pluginExpress from '@gasket/plugin-express';
-import pluginHttps from '@gasket/plugin-https';
-import pluginDocs from '@gasket/plugin-docs';
-import pluginDocusaurus from '@gasket/plugin-docusaurus';
-import pluginResponseData from '@gasket/plugin-response-data';
-import pluginWinston from '@gasket/plugin-winston';
-import pluginSwagger from '@gasket/plugin-swagger';
-import pluginLint from '@gasket/plugin-lint';
 import { createRequire } from 'module';
-import { fileURLToPath } from 'url';
+import presetPrompt from './preset-prompt.js';
+import presetConfig from './preset-config.js';
+import create from './create.js';
 const require = createRequire(import.meta.url);
-const { name, dependencies, devDependencies } = require('../package.json');
+const { name, version, description } = require('../package.json');
 
+// TODO: need to create types for "preset" plugins
 export default {
   name,
+  version,
+  description,
   hooks: {
-    async presetPrompt(gasket, context, { prompt }) {
-      context.apiApp = true;
-      // TODOfollowup - TS prompt could possibly be global
-      if (!('typescript' in context)) {
-        const { typescript } = await prompt([
-          {
-            name: 'typescript',
-            message: 'Do you want to use TypeScript?',
-            type: 'confirm',
-            default: false
-          }
-        ]);
-
-        Object.assign(context, { typescript });
-      }
-    },
-    async presetConfig(gasket, context) {
-      let testPlugin, typescriptPlugin;
-      if ('testPlugin' in context) {
-        testPlugin = await import(context.testPlugin);
-      }
-
-      if (context.typescript) {
-        typescriptPlugin = await import('@gasket/plugin-typescript');
-      }
-
-      return {
-        plugins: [
-          pluginExpress,
-          pluginHttps,
-          pluginDocs,
-          pluginDocusaurus,
-          pluginResponseData,
-          pluginWinston,
-          pluginSwagger,
-          pluginLint,
-          typescriptPlugin ? typescriptPlugin.default || typescriptPlugin : null,
-          testPlugin ? testPlugin.default || testPlugin : null
-        ].filter(Boolean)
-      }
-    },
-    create(gasket, context) {
-      const { pkg, files } = context;
-      const __dirname = fileURLToPath(import.meta.url);
-      const generatorDir = `${__dirname}/../../generator`;
-
-      pkg.add('dependencies', dependencies);
-
-      if (!context.typescript) {
-        files.add(`${generatorDir}/*`);
-
-        pkg.add('devDependencies', devDependencies);
-
-        pkg.add('scripts', {
-          start: 'node server.js',
-          local: 'GASKET_ENV=local nodemon server.js',
-        });
-      }
-    }
+    presetPrompt,
+    presetConfig,
+    create
   }
 };

package/lib/preset-config.js

@@ -0,0 +1,43 @@
+import pluginHttps from '@gasket/plugin-https';
+import pluginData from '@gasket/plugin-data';
+import pluginWinston from '@gasket/plugin-winston';
+import pluginSwagger from '@gasket/plugin-swagger';
+import pluginLint from '@gasket/plugin-lint';
+
+/**
+ * presetConfig hook
+ * @param {Gasket} gasket - Gasket API
+ * @param {Create} context - Create context
+ * @returns {Promise<CreateContext.presetConfig>} config
+ */
+export default async function presetConfig(gasket, context) {
+  let typescriptPlugin;
+  const testPlugins = [];
+  const frameworkPlugin = context.server === 'express'
+    ? await import('@gasket/plugin-express')
+    : await import('@gasket/plugin-fastify');
+
+  if ('testPlugins' in context && context.testPlugins.length > 0) {
+    await Promise.all(context.testPlugins.map(async (testPlugin) => {
+      const plugin = await import(testPlugin);
+      testPlugins.push(plugin ? plugin.default || plugin : null);
+    }));
+  }
+
+  if (context.typescript) {
+    typescriptPlugin = await import('@gasket/plugin-typescript');
+  }
+
+  return {
+    plugins: [
+      pluginHttps,
+      pluginData,
+      pluginWinston,
+      pluginSwagger,
+      pluginLint,
+      frameworkPlugin.default || frameworkPlugin,
+      typescriptPlugin ? typescriptPlugin.default || typescriptPlugin : null,
+      ...testPlugins
+    ].filter(Boolean)
+  };
+}

package/lib/preset-prompt.js

@@ -0,0 +1,32 @@
+import typescriptPrompts from '@gasket/plugin-typescript/prompts';
+
+/**
+ * presetPrompt hook
+ * @param {Gasket} gasket - Gasket API
+ * @param {Create} context - Create context
+ * @param {Object} utils - Prompt utils
+ * @param {Function} utils.prompt - Inquirer prompt
+ */
+export default async function presetPrompt(gasket, context, { prompt }) {
+  context.apiApp = true;
+
+  await typescriptPrompts.promptTypescript(context, prompt);
+
+  if (!('server' in context)) {
+    const { server } = await prompt([
+      {
+        name: 'server',
+        message: 'Which server framework would you like to use?',
+        type: 'list',
+        choices: [
+          { name: 'Express', value: 'express' },
+          { name: 'Fastify', value: 'fastify' }
+        ]
+      }
+    ]);
+
+    Object.assign(context, { server });
+
+    return context;
+  }
+}

package/package.json

@@ -1,13 +1,22 @@
 {
   "name": "@gasket/preset-api",
-  "version": "7.0.0-next.5",
+  "version": "7.0.0-next.50",
   "description": "Create Express-based API with Gasket",
+  "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
+    "generator",
     "lib"
   ],
-  "type": "module",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
+    "test:watch": "npm run test -- --watch",
+    "test:coverage": "jest --coverage",
+    "posttest": "npm run lint"
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/godaddy/gasket.git"
@@ -21,20 +30,44 @@
     "url": "https://github.com/godaddy/gasket/issues"
   },
   "dependencies": {
-    "@gasket/core": "^7.0.0-next.5",
-    "@gasket/engine": "^7.0.0-next.5",
-    "@gasket/plugin-docs": "^7.0.0-next.5",
-    "@gasket/plugin-docusaurus": "^7.0.0-next.5",
-    "@gasket/plugin-express": "^7.0.0-next.5",
-    "@gasket/plugin-https": "^7.0.0-next.5",
-    "@gasket/plugin-lint": "^7.0.0-next.5",
-    "@gasket/plugin-response-data": "^7.0.0-next.5",
-    "@gasket/plugin-swagger": "^7.0.0-next.5",
-    "@gasket/plugin-winston": "^7.0.0-next.5",
-    "@gasket/utils": "^7.0.0-next.5"
+    "@gasket/plugin-cypress": "^7.0.0-next.50",
+    "@gasket/plugin-data": "^7.0.0-next.50",
+    "@gasket/plugin-express": "^7.0.0-next.50",
+    "@gasket/plugin-fastify": "^7.0.0-next.50",
+    "@gasket/plugin-https": "^7.0.0-next.50",
+    "@gasket/plugin-jest": "^7.0.0-next.50",
+    "@gasket/plugin-lint": "^7.0.0-next.50",
+    "@gasket/plugin-mocha": "^7.0.0-next.50",
+    "@gasket/plugin-swagger": "^7.0.0-next.50",
+    "@gasket/plugin-typescript": "^7.0.0-next.50",
+    "@gasket/plugin-winston": "^7.0.0-next.50"
   },
   "devDependencies": {
+    "cross-env": "^7.0.3",
+    "eslint": "^8.56.0",
+    "eslint-config-godaddy": "^7.1.1",
+    "eslint-plugin-jest": "^28.6.0",
+    "eslint-plugin-unicorn": "^55.0.0",
+    "jest": "^29.7.0",
     "nodemon": "^3.1.0"
   },
-  "gitHead": "b3b132ef284ac43616794283b969c23c45c0a90e"
+  "eslintConfig": {
+    "extends": [
+      "godaddy",
+      "plugin:jest/recommended"
+    ],
+    "plugins": [
+      "unicorn"
+    ],
+    "rules": {
+      "unicorn/filename-case": "error"
+    }
+  },
+  "eslintIgnore": [
+    "test/fixtures"
+  ],
+  "jest": {
+    "transform": {}
+  },
+  "gitHead": "e7cfec6a118cf087c6532c23dc31170f4b15d182"
 }