Get scratchpad working with create script (#347)

* Add package.json

* Run hook

* run hook

* mv back

* use start.watch

* add quickstart method

* not global

Author: lorensr

.scripts/copy-shared-files.mjs

@@ -20,6 +20,7 @@ const TSCONFIG_EXCLUDE = [
   'nestjs-exchange-rates',
   'empty',
   'hello-world',
+  'scratchpad',
 ];
 const GITIGNORE_EXCLUDE = [
   'nextjs-ecommerce-oneclick',

scratchpad/.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+lib
+.eslintrc.js

scratchpad/.eslintrc.js

@@ -0,0 +1,48 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['@typescript-eslint', 'deprecation'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  rules: {
+    // recommended for safety
+    '@typescript-eslint/no-floating-promises': 'error', // forgetting to await Activities and Workflow APIs is bad
+    'deprecation/deprecation': 'warn',
+
+    // code style preference
+    'object-shorthand': ['error', 'always'],
+
+    // relaxed rules, for convenience
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      },
+    ],
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter((m) => !ALLOWED_NODE_BUILTINS.has(m)).flatMap((m) => [m, `node:${m}`]),
+        ],
+      },
+    },
+  ],
+};

scratchpad/.gitignore

@@ -0,0 +1,2 @@
+lib
+node_modules

scratchpad/.npmrc

@@ -0,0 +1 @@
+package-lock=false

scratchpad/.nvmrc

@@ -0,0 +1 @@
+16

scratchpad/.post-create

@@ -7,9 +7,11 @@ Start Temporal Server:
 
   {cyan temporal server start-dev}
 
-Install ts-node: https://www.npmjs.com/package/ts-node
+Use Node version 16+:
 
-Then, in the project directory, install the Temporal SDK and run scratchpad.ts:
+  Mac: {cyan brew install node@16}
+  Other: https://nodejs.org/en/download/
 
-  {cyan npm install temporalio}
-  {cyan ts-node scratchpad.ts}
+Then, in the project directory, run scratchpad.ts:
+
+  {cyan npm run start.watch}

scratchpad/.prettierignore

@@ -0,0 +1 @@
+lib

scratchpad/.prettierrc

@@ -0,0 +1,2 @@
+printWidth: 120
+singleQuote: true

scratchpad/README.md

@@ -3,20 +3,23 @@
 This sample demonstrates a minimalistic single-file style that might be useful for quickly sketching out an idea, or for sharing a minimal reproduction of a bug.
 Production code should not be arranged like this! See the other samples in this repo for recommended project structure.
 
-### Running this sample
+### Quickstart
 
-In one terminal:
+To get started quickly without cloning:
 
-```
-temporal server start-dev
+```sh
+npm i ts-node temporalio
+curl -sOL https://raw.githubusercontent.com/temporalio/samples-typescript/main/scratchpad/scratchpad.ts
+ts-node scratchpad.ts
 ```
 
-In another terminal:
+### Watch changes
 
-```
-npm install temporalio
-ts-node scratchpad.ts
-```
+If you've cloned this repo locally, you can run:
+
+1. `temporal server start-dev` to start [Temporal Server](https://github.com/temporalio/cli/#installation).
+1. `npm install` to install dependencies.
+1. `npm run start.watch` to run the single file, [`scratchpad.ts`](scratchpad.ts).
 
 The following will be printed out: