Add template for npm package

.changeset/neat-lobsters-suffer.md

@@ -0,0 +1,8 @@
+---
+'skuba': minor
+---
+
+Add template for private npm packages
+
+This change also defaults TypeScript's `moduleResolution` to `node`.
+This shouldn't break any existing consumers as it is the default resolution strategy for CommonJS.

.github/workflows/validate.yml

@@ -41,6 +41,7 @@ jobs:
           - greeter
           - koa-rest-api
           - lambda-sqs-worker
+          - private-npm-package
     steps:
       - name: Check out repo
         uses: actions/checkout@master

README.md

@@ -152,6 +152,11 @@ This initialises a new directory and Git repository.
   a message queue is employed between the source topic and the Lambda function,
   and unprocessed events are sent to a dead-letter queue for manual triage.
 
+- `private-npm-package`
+
+  Set up a new private npm module published using a semantic release pipeline.
+  At the moment this only supports the `@seek` private npm org.
+
 - `github →` (experimental)
 
   BYO starter repo!
@@ -174,7 +179,8 @@ skuba init << EOF
   "destinationDir": "tmp-greeter",
   "templateComplete": true,
   "templateData": {
-    "gitHubTeamName": "@seek-jobs/my-team",
+    "teamName": "my-team",
+    "orgName": "my-org",
     "prodBuildkiteQueueName": "my-team-prod:cicd",
     "repoName": "tmp-greeter"
   },

config/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "incremental": true
+    "incremental": true,
+    "moduleResolution": "node"
   },
   "extends": "tsconfig-seek"
 }

package.json

@@ -66,6 +66,7 @@
     "prettier": "2.0.5",
     "read-pkg-up": "^7.0.1",
     "runtypes": "^4.2.0",
+    "semantic-release": "^17.0.8",
     "ts-jest": "^26.0.0",
     "ts-node": "^8.10.1",
     "ts-node-dev": "^1.0.0-pre.44",

scripts/test-template.sh

@@ -21,7 +21,9 @@ yarn skuba init << EOF
     "description": "description",
     "devBuildkiteQueueName": "my-account-dev:cicd",
     "devGantryEnvironmentName": "dev",
-    "gitHubTeamName": "@my-org/my-team",
+    "teamName": "my-team",
+    "moduleName": "first-module",
+    "orgName": "my-org",
     "prodAwsAccountId": "000000000000",
     "prodBuildkiteQueueName": "my-account-prod:cicd",
     "prodGantryEnvironmentName": "prod",

src/cli/init/prompts.ts

@@ -15,11 +15,14 @@ export const BASE_CHOICES = [
     },
   },
   {
-    name: 'gitHubTeamName',
+    name: 'orgName',
+    message: 'Github org name',
+    initial: 'my-org',
+  },
+  {
+    name: 'teamName',
     message: 'GitHub team',
-    initial: '@seek-jobs/my-team',
-    validate: (value: string) =>
-      /^@.+\/.+$/.test(value) || 'GitHub team is not valid',
+    initial: 'my-team',
   },
 ] as const;
 
@@ -41,6 +44,7 @@ export const TEMPLATE_PROMPT = new Select({
     'greeter',
     'koa-rest-api',
     'lambda-sqs-worker',
+    'private-npm-package',
     'github →',
   ] as const,
   message: 'Select a template:',

src/cli/init/types.ts

@@ -10,8 +10,9 @@ export const InitConfig = t.Record({
   templateComplete: t.Boolean,
   templateData: t
     .Record({
-      gitHubTeamName: t.String,
+      teamName: t.String,
       repoName: t.String,
+      orgName: t.String,
     })
     .And(t.Dictionary(t.String, 'string')),
   templateName: t.String,

src/cli/release.ts

@@ -0,0 +1,5 @@
+import { exec } from '../utils/exec';
+
+export const release = async () => {
+  await exec('semantic-release', '--success', 'false');
+};

src/utils/command.ts

@@ -20,6 +20,7 @@ export const COMMAND_LIST = [
   'help',
   'init',
   'lint',
+  'release',
   'start',
   'test',
   'version',

template/base/.github/CODEOWNERS

@@ -1,4 +1,4 @@
-* <%- gitHubTeamName %>
+* @<%- orgName %>/<%- teamName %>
 
 # Configured by Renovate
 package.json

template/private-npm-package/.buildkite/pipeline.yml

@@ -0,0 +1,4 @@
+steps:
+  - command: aws s3 cp s3://seek-npm-package-buildkite-pipeline/pipeline-latest.sh - | bash | buildkite-agent pipeline upload
+    agents:
+      queue: artefacts:npm

template/private-npm-package/README.md

@@ -0,0 +1,64 @@
+# <%- moduleName %>
+
+[![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
+
+<!--
+
+## Table of contents
+
+- [Usage](#usage)
+- [Design](#design)
+- [Development](#development)
+- [Support](#support)
+
+## Usage
+
+...
+
+## Design
+
+...
+
+## Development
+
+...
+
+## Support
+
+...
+
+-->
+
+To publish your module to npm and release notes to GitHub:
+
+## Release
+
+While a Buildkite pipeline for CI/CD is generated out of the box, there are some additional steps to get semantic-release working:
+
+<https://github.com/SEEK-Jobs/npm-package-buildkite-pipeline#installing-on-your-repository>
+
+### Releasing latest
+
+Commits to the `master` branch will be released with the `latest` tag, which is the default used when running `npm install` or `yarn install`.
+
+### Releasing other dist-tags
+
+semantic-release prescribes a branch-based workflow for managing [distribution tags].
+
+[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
+
+You can push to other branches to manage betas, maintenance updates to prior major versions, and more.
+
+Here are some branches that semantic-release supports by default:
+
+| Git branch | npm dist-tag |
+| :--------- | :----------- |
+| master     | latest       |
+| alpha      | alpha        |
+| beta       | beta         |
+| next       | next         |
+| 1.x        | release-1.x  |
+
+For more information, see the semantic-release docs:
+
+<https://github.com/semantic-release/semantic-release/#triggering-a-release>

template/private-npm-package/_.nvmrc

@@ -0,0 +1 @@
+lts/*

template/private-npm-package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "<%- moduleName %>",
+  "description": "<%- description %>",
+  "version": "0.0.0-semantically-released",
+  "main": "./lib-commonjs",
+  "module": "./lib-es2015",
+  "typings": "./lib-types",
+  "files": [
+    "lib*/**/*.d.ts",
+    "lib*/**/*.js",
+    "lib*/**/*.js.map"
+  ],
+  "sideEffects": false,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "skuba build-package",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "release": "yarn build && skuba release",
+    "test": "skuba test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/<%- orgName %>/<%- repoName %>.git"
+  }
+}

template/private-npm-package/skuba.template.js

@@ -0,0 +1,22 @@
+/**
+ * Run `skuba configure` to finish templating and remove this file.
+ */
+
+module.exports = {
+  entryPoint: 'src/index.ts',
+  fields: [
+    {
+      name: 'moduleName',
+      message: 'Module name',
+      initial: '@seek/my-first-module',
+      validate: (value) =>
+        /^@seek\/.+$/.test(value) ||
+        `module must start with an ${chalk.bold('@seek/')} scope`,
+    },
+    {
+      name: 'description',
+      message: 'Description',
+      initial: 'This is my first module',
+    },
+  ],
+};

template/private-npm-package/src/index.test.ts

@@ -0,0 +1,5 @@
+import { log } from './index';
+
+describe('app', () => {
+  it('defines a log function', () => expect(log).toBeDefined());
+});

template/private-npm-package/src/index.ts

@@ -0,0 +1,3 @@
+export const log = () =>
+  /* eslint-disable-next-line no-console */
+  console.log('<%- moduleName %>');