create-sails-generator 0.0.0 → 0.0.1

package/README

@@ -1,6 +1,6 @@
 # create-sails-generator: A Sails Generator for The Boring JavaScript Stack
 
-Welcome to the Create-Sails-Generator! This generator is specifically designed for The Boring JavaScript Stack, providing a plethora of CLI commands for code generation and more to expedite your development process with Sails.js.
+This generator is specifically designed for The Boring JavaScript Stack, providing a plethora of commands for code generation and more to expedite your development process with The Boring JavaScript Stack.
 
 ## Features
 

package/generators/bad-request/index.js

@@ -0,0 +1,24 @@
+const path = require('path')
+/**
+ * Generates responses/badRequest.js file
+ */
+module.exports = {
+  before: function (scope, done) {
+    if (scope.force !== false) {
+      scope.force = true
+    }
+    scope.relPath = 'badRequest.js'
+    return done()
+  },
+  after: function (scope, done) {
+    console.log()
+    console.log(`Successfully generated ${scope.relPath}`)
+    console.log(' •-', `api/responses/${scope.relPath}`)
+    console.log()
+    return done()
+  },
+  targets: {
+    './api/responses/:relPath': { copy: 'badRequest.js' }
+  },
+  templatesDirectory: path.resolve(__dirname, './templates')
+}

package/generators/bad-request/templates/badRequest.js

@@ -0,0 +1,95 @@
+/**
+ * badRequest.js
+ *
+ * A custom response.
+ *
+ * Example usage:
+ * ```
+ *     return res.badRequest();
+ *     // -or-
+ *     return res.badRequest(optionalData);
+ * ```
+ *
+ * Or with actions2:
+ * ```
+ *     exits: {
+ *       somethingHappened: {
+ *         responseType: 'badRequest'
+ *       }
+ *     }
+ * ```
+ *
+ * ```
+ *     throw 'somethingHappened';
+ *     // -or-
+ *     throw { somethingHappened: optionalData }
+ * ```
+ */
+
+module.exports = function badRequest(optionalData) {
+  // Get access to `req` and `res`
+  const req = this.req
+  const res = this.res
+
+  // Define the status code to send in the response.
+  const statusCodeToSet = 400
+
+  // Check if it's an Inertia request
+  if (req.header('X-Inertia')) {
+    if (optionalData && optionalData.problems) {
+      const errors = {}
+      optionalData.problems.forEach((problem) => {
+        if (typeof problem === 'object') {
+          Object.keys(problem).forEach((propertyName) => {
+            const sanitizedProblem = problem[propertyName].replace(/\.$/, '') // Trim trailing dot
+            if (!errors[propertyName]) {
+              errors[propertyName] = [sanitizedProblem]
+            } else {
+              errors[propertyName].push(sanitizedProblem)
+            }
+          })
+        } else {
+          const regex = /"(.*?)"/
+          const matches = problem.match(regex)
+
+          if (matches && matches.length > 1) {
+            const propertyName = matches[1]
+            const sanitizedProblem = problem
+              .replace(/"([^"]+)"/, '$1')
+              .replace('\n', '')
+              .replace('·', '')
+              .trim()
+            if (!errors[propertyName]) {
+              errors[propertyName] = [sanitizedProblem]
+            } else {
+              errors[propertyName].push(sanitizedProblem)
+            }
+          }
+        }
+      })
+      req.session.errors = errors
+      return res.redirect(303, 'back')
+    }
+  }
+
+  // If not an Inertia request, perform the normal badRequest response
+  if (optionalData === undefined) {
+    sails.log.info('Ran custom response: res.badRequest()')
+    return res.sendStatus(statusCodeToSet)
+  } else if (_.isError(optionalData)) {
+    sails.log.info(
+      'Custom response `res.badRequest()` called with an Error:',
+      optionalData
+    )
+
+    if (!_.isFunction(optionalData.toJSON)) {
+      if (process.env.NODE_ENV === 'production') {
+        return res.sendStatus(statusCodeToSet)
+      } else {
+        return res.status(statusCodeToSet).send(optionalData.stack)
+      }
+    }
+  } else {
+    return res.status(statusCodeToSet).send(optionalData)
+  }
+}

package/generators/inertia/index.js

@@ -0,0 +1,24 @@
+const path = require('path')
+/**
+ * Generates responses/inertia.js file
+ */
+module.exports = {
+  before: function (scope, done) {
+    if (scope.force !== false) {
+      scope.force = true
+    }
+    scope.relPath = 'inertia.js'
+    return done()
+  },
+  after: function (scope, done) {
+    console.log()
+    console.log(`Successfully generated ${scope.relPath}`)
+    console.log(' •-', `api/responses/${scope.relPath}`)
+    console.log()
+    return done()
+  },
+  targets: {
+    './api/responses/:relPath': { copy: 'inertia.js' }
+  },
+  templatesDirectory: path.resolve(__dirname, './templates')
+}

package/generators/inertia/templates/inertia.js

@@ -0,0 +1,72 @@
+// @ts-nocheck
+const { encode } = require('querystring')
+module.exports = function inertia(data) {
+  const req = this.req
+  const res = this.res
+  const sails = req._sails
+
+  const sharedProps = sails.inertia.sharedProps
+  const sharedViewData = sails.inertia.sharedViewData
+  const rootView = sails.config.inertia.rootView
+
+  const allProps = {
+    ...sharedProps,
+    ...data.props
+  }
+
+  const allViewData = {
+    ...sharedViewData,
+    ...data.viewData
+  }
+
+  let url = req.url || req.originalUrl
+  const assetVersion = sails.config.inertia.version
+  const currentVersion =
+    typeof assetVersion === 'function' ? assetVersion() : assetVersion
+
+  const page = {
+    component: data.page,
+    version: currentVersion,
+    props: allProps,
+    url
+  }
+
+  // Implements inertia partial reload. See https://inertiajs.com/partial-reload
+  if (
+    req.get(inertiaHeaders.PARTIAL_DATA) &&
+    req.get(inertiaHeaders.PARTIAL_COMPONENT) === page.component
+  ) {
+    const only = req.get(inertiaHeaders.PARTIAL_DATA).split(',')
+    page.props = only.length ? getPartialData(data.props, only) : page.props
+  }
+
+  const queryParams = req.query
+  if (req.method === 'GET' && Object.keys(queryParams).length) {
+    // Keep original request query params
+    url += `?${encode(queryParams)}`
+  }
+
+  if (req.get(inertiaHeaders.INERTIA)) {
+    res.set(inertiaHeaders.INERTIA, true)
+    res.set('Vary', 'Accept')
+    return res.json(page)
+  } else {
+    // Implements full page reload
+    return res.view(rootView, {
+      page,
+      viewData: allViewData
+    })
+  }
+}
+
+function getPartialData(props, only = []) {
+  return Object.assign({}, ...only.map((key) => ({ [key]: props[key] })))
+}
+
+const inertiaHeaders = {
+  INERTIA: 'X-Inertia',
+  VERSION: 'X-Inertia-Version',
+  PARTIAL_DATA: 'X-Inertia-Partial-Data',
+  PARTIAL_COMPONENT: 'X-Inertia-Partial-Component',
+  LOCATION: 'X-Inertia-Location'
+}

package/generators/inertia-redirect/index.js

@@ -0,0 +1,24 @@
+const path = require('path')
+/**
+ * Generates responses/inertia.js file
+ */
+module.exports = {
+  before: function (scope, done) {
+    if (scope.force !== false) {
+      scope.force = true
+    }
+    scope.relPath = 'inertiaRedirect.js'
+    return done()
+  },
+  after: function (scope, done) {
+    console.log()
+    console.log(`Successfully generated ${scope.relPath}`)
+    console.log(' •-', `api/responses/${scope.relPath}`)
+    console.log()
+    return done()
+  },
+  targets: {
+    './api/responses/:relPath': { copy: 'inertiaRedirect.js' }
+  },
+  templatesDirectory: path.resolve(__dirname, './templates')
+}

package/generators/inertia-redirect/templates/inertiaRedirect.js

@@ -0,0 +1,20 @@
+// @ts-nocheck
+
+const inertiaHeaders = {
+  INERTIA: 'X-Inertia',
+  LOCATION: 'X-Inertia-Location'
+}
+
+module.exports = function inertiaRedirect(url) {
+  const req = this.req
+  const res = this.res
+
+  if (req.get(inertiaHeaders.INERTIA)) {
+    res.set(inertiaHeaders.LOCATION, url)
+  }
+
+  return res.redirect(
+    ['PUT', 'PATCH', 'DELETE'].includes(req.method) ? 303 : 409,
+    url
+  )
+}

package/generators/page/index.js

@@ -0,0 +1,70 @@
+const path = require('path')
+const getUiFramework = require('../../utils/get-ui-framework')
+const getComponentName = require('../../utils/get-component-name')
+const getFileExtensionForUi = require('../../utils/get-file-extension-for-ui')
+const getActionName = require('../../utils/get-action-name')
+/**
+ * Generates responses/inertia.js file
+ */
+
+module.exports = {
+  before: function (scope, done) {
+    const appPackageJSON = require(`${scope.topLvlRootPath}/package.json`)
+    const uiFramework = getUiFramework(appPackageJSON)
+    let roughName
+
+    if (scope.name) {
+      roughName = scope.name
+    }
+
+    if (scope.args[0] && typeof scope.args[0] == 'string') {
+      roughName = scope.args[0]
+    }
+
+    if (!roughName) {
+      return done(
+        new Error(
+          'Missing argument: Please provide a name for the new page.\n' +
+            '(e.g. `profile` or `sign-up`).'
+        )
+      )
+    }
+
+    // Replace backslashes with proper slashes.
+    // (This is crucial for Windows compatibility.)
+    roughName = roughName.replace(/\\/g, '/')
+
+    scope.pageRelPath = roughName.replace(/\.+/g, '/')
+    scope.pagePath = scope.pageRelPath
+    console.log(scope.pagePath)
+    scope.pageRelPath += getFileExtensionForUi(uiFramework)
+    scope.uiFramework = uiFramework
+    if (uiFramework == 'react') {
+      scope.componentName = getComponentName(roughName)
+    }
+
+    scope.actionRelPath = getActionName(roughName)
+    scope.actionRelPath += '.js'
+    scope.actionFriendlyName = `View ${scope.pagePath}`
+    scope.actionDescription = `Display ${scope.pagePath} page`
+
+    return done()
+  },
+  after: function (scope, done) {
+    console.log()
+
+    console.log(`Successfully generated ${scope.pageRelPath}`)
+    console.log(' •-', `assets/js/pages/${scope.pageRelPath}`)
+
+    console.log(`Successfully generated ${scope.actionRelPath}`)
+    console.log(' •-', `api/controllers/${scope.actionRelPath}`)
+
+    console.log()
+    return done()
+  },
+  targets: {
+    './assets/js/pages/:pageRelPath': { template: 'page.template' },
+    './api/controllers/:actionRelPath': { template: 'action.template' }
+  },
+  templatesDirectory: path.resolve(__dirname, './templates')
+}

package/generators/page/templates/action.template

@@ -0,0 +1,15 @@
+module.exports = {
+  friendlyName: <%= util.inspect(actionFriendlyName) %>,
+
+  description: <%= util.inspect(actionDescription) %>,
+
+  exits: {
+    success: {
+      responseType: 'inertia'
+    }
+  },
+
+  fn: async function () {
+    return { page: <%= util.inspect(pagePath) %> }
+  }
+}

package/generators/page/templates/page.template

@@ -0,0 +1,19 @@
+<% if (uiFramework == 'vue') {%>
+<script setup>
+import { Head, Link, useForm, usePage } from '@inertiajs/vue3'
+</script>
+
+<template></template>
+<% } else if (uiFramework == 'react') { %>
+import { Head, Link, useForm, usePage } from '@inertiajs/react'
+
+export default function <%= componentName %>(props) {
+  return <div></div>
+}
+<% } else if (uiFramework == 'svelte') { %>
+<script>
+  import { Link, useForm, page } from '@inertiajs/svelte'
+</script>
+
+<div></div>
+<% } %>

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "create-sails-generator",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Sails generator for The Boring JavaScript Stack.",
-  "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node --test"
   },
-  "keywords": ["The Boring JavaScript Stack", "sails", "senerator"],
+  "keywords": [
+    "The Boring JavaScript Stack",
+    "sails",
+    "senerator"
+  ],
   "author": "Kelvin Omereshone<kelvin@sailscasts.com>",
   "license": "MIT",
   "peerDependencies": {

package/tests/utils/get-action-name.test.js

@@ -0,0 +1,12 @@
+const { describe, it } = require('node:test')
+const assert = require('node:assert/strict')
+const getActionName = require('../../utils/get-action-name')
+
+describe('getActionName', function () {
+  it("returns 'view-dashboard' when given 'dashboard'", function () {
+    assert.equal(getActionName('dashboard'), 'view-dashboard')
+  })
+  it("returns 'user/view-users' when given 'users/index'", function () {
+    assert.equal(getActionName('users/index'), 'user/view-users')
+  })
+})

package/tests/utils/get-component-name.test.js

@@ -0,0 +1,15 @@
+const { describe, it } = require('node:test')
+const assert = require('node:assert/strict')
+const getComponentName = require('../../utils/get-component-name')
+
+describe('getComponentName', function () {
+  it("returns 'Profile' when given 'profile'", function () {
+    assert.equal(getComponentName('profile'), 'Profile')
+  })
+  it("returns 'UserDashboard' when given 'user-dashboard'", function () {
+    assert.equal(getComponentName('user-dashboard'), 'UserDashboard')
+  })
+  it("returns 'ExampleNewPage' when given 'example/new-page'", function () {
+    assert.equal(getComponentName('example/new-page'), 'ExampleNewPage')
+  })
+})

package/tests/utils/get-file-extension-for-ui.test.js

@@ -0,0 +1,15 @@
+const { describe, it } = require('node:test')
+const assert = require('node:assert/strict')
+const getFileExtensionForUI = require('../../utils/get-file-extension-for-ui')
+
+describe('getFileExtensionForUI', function () {
+  it("returns '.vue' when given 'vue'", function () {
+    assert.equal(getFileExtensionForUI('vue'), '.vue')
+  })
+  it("returns '.jsx' when given 'react'", function () {
+    assert.equal(getFileExtensionForUI('react'), '.jsx')
+  })
+  it("returns '.svelte' when given 'svelte'", function () {
+    assert.equal(getFileExtensionForUI('svelte'), '.svelte')
+  })
+})

package/utils/get-action-name.js

@@ -0,0 +1,7 @@
+module.exports = function getActionName(pageName) {
+  if (!pageName.includes('/')) return 'view-' + pageName
+  const [firstPart] = pageName.split('/')
+  const actionName = 'view-' + firstPart
+  const singularizedFirsPart = firstPart.replace(/s$/, '')
+  return `${singularizedFirsPart}/${actionName}`
+}

package/utils/get-component-name.js

@@ -0,0 +1,11 @@
+module.exports = function getComponentName(str) {
+  const words = str.split(/-|\//)
+
+  return words
+    .map((word, index) =>
+      index === 0
+        ? word.charAt(0).toUpperCase() + word.slice(1)
+        : word.charAt(0).toUpperCase() + word.slice(1)
+    )
+    .join('')
+}

package/utils/get-file-extension-for-ui.js

@@ -0,0 +1,9 @@
+module.exports = function getFileExtensionForUI(uiFramework) {
+  const extensions = {
+    vue: '.vue',
+    react: '.jsx',
+    svelte: '.svelte'
+  }
+
+  return extensions[uiFramework]
+}

package/utils/get-ui-framework.js

@@ -0,0 +1,13 @@
+module.exports = function getUIFramework(packageJSON) {
+  if (!packageJSON.dependencies)
+    throw new Error('Package.json do not have dependencies')
+  if (packageJSON.dependencies['@inertiajs/vue3']) {
+    return 'vue'
+  } else if (packageJSON.dependencies['@inertiajs/react']) {
+    return 'react'
+  } else if (packageJSON.dependencies['@inertiajs/svelte']) {
+    return 'svelte'
+  } else {
+    throw new Error('Could not get UI framework from package.json.')
+  }
+}