@airfleet/generator-init 0.3.1 → 0.4.0

package/README.md

@@ -22,6 +22,7 @@ npm install -g @airfleet/generator-init
 | --------- | ------------------------------------- | ----------------------------------------- |
 | Block     | `yo @airfleet/init:block --force`     | Create a block for the Airfleet Theme     |
 | Component | `yo @airfleet/init:component --force` | Create a component for the Airfleet Theme |
+| npm       | `yo @airfleet/init:npm --force`       | Generate an npm package for publishing    |
 
 ## Documentation
 

package/generators/npm/index.js

@@ -0,0 +1,110 @@
+"use strict";
+import Generator from "yeoman-generator";
+
+import nameCases from "../../utils/nameCases.js";
+import copyTemplates from "../../utils/copyTemplates.js";
+import mapFilesToTemplates from "../../utils/mapFilesToTemplates.js";
+import requiredText from "../../utils/validation/requiredText.js";
+import title from "../../utils/log/title.js";
+import highlightText from "../../utils/log/text/highlightText.js";
+import lines from "../../utils/log/text/lines.js";
+import brandText from "../../utils/log/text/brandText.js";
+import dangerText from "../../utils/log/text/dangerText.js";
+import infoBox from "../../utils/log/boxes/infoBox.js";
+
+export default class extends Generator {
+  async prompting() {
+    this.log(
+      lines([
+        title(`Let's generate an ${highlightText("npm package")}!`),
+        infoBox(
+          lines([
+            "This will create an npm package that will be",
+            `published to npm under the ${brandText("airfleet")} scope`,
+            "as soon as the changes are pushed to the main",
+            "branch.",
+            "",
+            dangerText("Make sure to add a feature in code and update"),
+            dangerText("change log before merging to main branch!"),
+            "",
+            "Before starting you should have:",
+            " - Created a repository",
+            " - Created the Notion page (can start empty)",
+            "",
+            "All the files will be created in the current",
+            "folder. Make sure to navigate to repo folder",
+            "first.",
+          ])
+        ),
+        "",
+      ])
+    );
+
+    const prompts = [
+      {
+        type: "input",
+        name: "npmName",
+        message: "What is the name of the npm package? (will be prescoped with \"@airfleet\")",
+        validate: requiredText("Please enter a name"),
+      },
+      {
+        type: "input",
+        name: "npmTitle",
+        message: "What is the title of the npm package?",
+        validate: requiredText("Please enter a title"),
+      },
+      {
+        type: "input",
+        name: "npmDescription",
+        message: "How would you describe the npm package?",
+        validate: requiredText("Please enter a description"),
+      },
+      {
+        type: "input",
+        name: "npmRepository",
+        message: "What's the repository URL? (start with https and end with .git)",
+        validate: requiredText("Please enter the repository URL"),
+      },
+      {
+        type: "input",
+        name: "npmDocumentationUrl",
+        message: "What's the documentation URL? (Notion page)",
+        validate: requiredText("Please enter the documentation URL"),
+      },
+      {
+        type: "input",
+        name: "npmNodeVersion",
+        message: "What's the required Node version?",
+        validate: requiredText("Please enter the Node version"),
+        default: ">=14",
+      },
+    ];
+
+    this.answers = await this.prompt(prompts);
+    this.name = nameCases(this.answers.npmName);
+    this.data = {
+      answers: this.answers,
+      name: this.name,
+      packageName: `@airfleet/${this.name.slug}`,
+      repositoryBase: this.answers.npmRepository.replace(/\.git$/, ""),
+      year: new Date().getFullYear(),
+    };
+  }
+
+  writing() {
+    const files = [
+      ".airfleet-release",
+      ".editorconfig",
+      ".gitattributes",
+      ".gitignore",
+      ".gitlab-ci.yml",
+      "CHANGELOG.md",
+      "LICENSE.ejs",
+      "package.json.ejs",
+      "README.md.ejs",
+    ];
+    const templates = mapFilesToTemplates(files);
+
+    copyTemplates(this, templates, this.data);
+  }
+}

package/generators/npm/templates/.airfleet-release

@@ -0,0 +1 @@
+minor

package/generators/npm/templates/.editorconfig

@@ -0,0 +1,18 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.php]
+indent_style = tab
+indent_size = 4

package/generators/npm/templates/.gitattributes

@@ -0,0 +1,11 @@
+*.js eol=lf
+*.jsx eol=lf
+*.ts eol=lf
+*.tsx eol=lf
+*.json eol=lf
+*.md eol=lf
+*.yml eol=lf
+*.yaml eol=lf
+*.css eol=lf
+*.scss eol=lf
+*.php eol=lf

package/generators/npm/templates/.gitlab-ci.yml

@@ -0,0 +1,8 @@
+stages:
+  - release
+
+include:
+  # Release process
+  - project: 'codersclan/tools/gitlab-ci-templates'
+    ref: main
+    file: '/release/npm.yaml'

package/generators/npm/templates/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Added

package/generators/npm/templates/LICENSE.ejs

@@ -0,0 +1,2 @@
+Copyright (c) <%= year %> Airfleet <dev@airfleet.co> (https://www.airfleet.co/)
+All rights reserved.

package/generators/npm/templates/README.md.ejs

@@ -0,0 +1,20 @@
+# <%= answers.npmTitle %>
+
+![npm](https://img.shields.io/npm/v/<%= packageName %>)
+[![pipeline status](<%= repositoryBase %>/badges/main/pipeline.svg)](<%= repositoryBase %>/-/commits/main)
+
+<%= answers.npmDescription %>
+
+## Install
+
+```bash
+npm install --save-dev <%= packageName %>
+```
+
+## Documentation
+
+- [Documentation](<%= answers.npmDocumentationUrl %>).
+
+## License
+
+© [Airfleet](https://www.airfleet.co/)

package/generators/npm/templates/package.json.ejs

@@ -0,0 +1,27 @@
+{
+  "name": "<%= packageName %>",
+  "description": "<%= answers.npmDescription %>",
+  "version": "0.0.0",
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "airfleet"
+  ],
+  "homepage": "https://www.airfleet.co",
+  "author": {
+    "name": "Airfleet",
+    "email": "dev@airfleet.co",
+    "url": "https://www.airfleet.co/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "<%= answers.npmRepository %>"
+  },
+  "type": "module",
+  "engines": {
+    "node": "<%- answers.npmNodeVersion %>"
+  },
+  "dependencies": {}
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@airfleet/generator-init",
   "description": "A Yeoman generator to scaffold common Airfleet features",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "scripts": {},
   "publishConfig": {
     "access": "public"
@@ -38,9 +38,5 @@
     "title-case": "^3.0.3",
     "yeoman-generator": "^5.4.2",
     "yosay": "^2.0.2"
-  },
-  "devDependencies": {
-    "@release-it/keep-a-changelog": "^2.3.0",
-    "release-it": "^14.11.7"
   }
 }

package/utils/mapFilesToTemplates.js

@@ -0,0 +1,13 @@
+/**
+ * Take a list of strings and create objects to be passed to `copyTemplates`.
+ * Assumes all files/templates will be copied to the same directory.
+ *
+ * @param {string[]} files Template files.
+ */
+export default function mapFilesToTemplates(files) {
+  return files.map((file) => ({
+    template: file,
+    destination: file.replace(/\.ejs$/, ""),
+    isEnabled: true,
+  }));
+}