Convert to typescript

Author: peter-evans

.eslintignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.eslintrc.json

@@ -1,17 +1,19 @@
 {
-    "env": {
-        "commonjs": true,
-        "es6": true,
-        "node": true
-    },
-    "extends": "eslint:recommended",
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "ecmaVersion": 2018
-    },
-    "rules": {
-    }
-}
+  "env": { "node": true, "jest": true },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "plugin:prettier/recommended",
+    "prettier/@typescript-eslint"
+  ],
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/camelcase": "off"
+  }
+}

.github/workflows/ci.yml

@@ -19,8 +19,10 @@ jobs:
         with:
           node-version: 12.x
       - run: npm ci
+      - run: npm run build
+      - run: npm run format-check
+      - run: npm run lint
       - run: npm run test
-      - run: npm run package
       - uses: actions/upload-artifact@v2
         with:
           name: dist

.gitignore

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

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid",
+  "parser": "typescript"
+}

__test__/command-helper.test.ts

@@ -0,0 +1,231 @@
+import {
+  Inputs,
+  Command,
+  SlashCommandPayload,
+  commandDefaults,
+  getCommandsConfigFromInputs,
+  getCommandsConfigFromJson,
+  actorHasPermission,
+  configIsValid,
+  getSlashCommandPayload
+} from '../lib/command-helper'
+
+describe('command-helper tests', () => {
+  test('building config with required inputs only', async () => {
+    const inputs: Inputs = {
+      token: '',
+      reactionToken: '',
+      reactions: true,
+      commands: 'list, of, slash, commands',
+      permission: 'write',
+      issueType: 'both',
+      allowEdits: false,
+      // Should be process.env.GITHUB_REPOSITORY, but '' for tests
+      repository: '',
+      eventTypeSuffix: '-command',
+      namedArgs: false,
+      config: '',
+      configFromFile: ''
+    }
+    const commands = inputs.commands.replace(/\s+/g, '').split(',')
+    const config = getCommandsConfigFromInputs(inputs)
+    expect(config.length).toEqual(4)
+    for (var i = 0; i < config.length; i++) {
+      expect(config[i].command).toEqual(commands[i])
+      expect(config[i].permission).toEqual(commandDefaults.permission)
+      expect(config[i].issue_type).toEqual(commandDefaults.issue_type)
+      expect(config[i].allow_edits).toEqual(commandDefaults.allow_edits)
+      expect(config[i].repository).toEqual(commandDefaults.repository)
+      expect(config[i].event_type_suffix).toEqual(
+        commandDefaults.event_type_suffix
+      )
+      expect(config[i].named_args).toEqual(commandDefaults.named_args)
+    }
+  })
+
+  test('building config with optional inputs', async () => {
+    const inputs: Inputs = {
+      token: '',
+      reactionToken: '',
+      reactions: true,
+      commands: 'list, of, slash, commands',
+      permission: 'admin',
+      issueType: 'pull-request',
+      allowEdits: true,
+      repository: 'owner/repo',
+      eventTypeSuffix: '-cmd',
+      namedArgs: true,
+      config: '',
+      configFromFile: ''
+    }
+    const commands = inputs.commands.replace(/\s+/g, '').split(',')
+    const config = getCommandsConfigFromInputs(inputs)
+    expect(config.length).toEqual(4)
+    for (var i = 0; i < config.length; i++) {
+      expect(config[i].command).toEqual(commands[i])
+      expect(config[i].permission).toEqual(inputs.permission)
+      expect(config[i].issue_type).toEqual(inputs.issueType)
+      expect(config[i].allow_edits).toEqual(inputs.allowEdits)
+      expect(config[i].repository).toEqual(inputs.repository)
+      expect(config[i].event_type_suffix).toEqual(inputs.eventTypeSuffix)
+      expect(config[i].named_args).toEqual(inputs.namedArgs)
+    }
+  })
+
+  test('building config with required JSON only', async () => {
+    const json = `[
+      {
+        "command": "do-stuff"
+      },
+      {
+        "command": "test-all-the-things"
+      }
+    ]`
+    const commands = ['do-stuff', 'test-all-the-things']
+    const config = getCommandsConfigFromJson(json)
+    expect(config.length).toEqual(2)
+    for (var i = 0; i < config.length; i++) {
+      expect(config[i].command).toEqual(commands[i])
+      expect(config[i].permission).toEqual(commandDefaults.permission)
+      expect(config[i].issue_type).toEqual(commandDefaults.issue_type)
+      expect(config[i].allow_edits).toEqual(commandDefaults.allow_edits)
+      expect(config[i].repository).toEqual(commandDefaults.repository)
+      expect(config[i].event_type_suffix).toEqual(
+        commandDefaults.event_type_suffix
+      )
+      expect(config[i].named_args).toEqual(commandDefaults.named_args)
+    }
+  })
+
+  test('building config with optional JSON properties', async () => {
+    const json = `[
+      {
+        "command": "do-stuff",
+        "permission": "admin",
+        "issue_type": "pull-request",
+        "allow_edits": true,
+        "repository": "owner/repo",
+        "event_type_suffix": "-cmd",
+        "named_args": true
+      },
+      {
+        "command": "test-all-the-things",
+        "permission": "read"
+      }
+    ]`
+    const commands = ['do-stuff', 'test-all-the-things']
+    const config = getCommandsConfigFromJson(json)
+    expect(config.length).toEqual(2)
+    expect(config[0].command).toEqual(commands[0])
+    expect(config[0].permission).toEqual('admin')
+    expect(config[0].issue_type).toEqual('pull-request')
+    expect(config[0].allow_edits).toBeTruthy()
+    expect(config[0].repository).toEqual('owner/repo')
+    expect(config[0].event_type_suffix).toEqual('-cmd')
+    expect(config[0].named_args).toBeTruthy()
+    expect(config[1].command).toEqual(commands[1])
+    expect(config[1].permission).toEqual('read')
+    expect(config[1].issue_type).toEqual(commandDefaults.issue_type)
+  })
+
+  test('valid config', async () => {
+    const config: Command[] = [
+      {
+        command: 'test',
+        permission: 'write',
+        issue_type: 'both',
+        allow_edits: false,
+        repository: 'peter-evans/slash-command-dispatch',
+        event_type_suffix: '-command',
+        named_args: false
+      }
+    ]
+    expect(configIsValid(config)).toBeTruthy()
+  })
+
+  test('invalid permission level in config', async () => {
+    const config: Command[] = [
+      {
+        command: 'test',
+        permission: 'test-case-invalid-permission',
+        issue_type: 'both',
+        allow_edits: false,
+        repository: 'peter-evans/slash-command-dispatch',
+        event_type_suffix: '-command',
+        named_args: false
+      }
+    ]
+    expect(configIsValid(config)).toBeFalsy()
+  })
+
+  test('invalid issue type in config', async () => {
+    const config: Command[] = [
+      {
+        command: 'test',
+        permission: 'write',
+        issue_type: 'test-case-invalid-issue-type',
+        allow_edits: false,
+        repository: 'peter-evans/slash-command-dispatch',
+        event_type_suffix: '-command',
+        named_args: false
+      }
+    ]
+    expect(configIsValid(config)).toBeFalsy()
+  })
+
+  test('actor does not have permission', async () => {
+    expect(actorHasPermission('none', 'read')).toBeFalsy()
+    expect(actorHasPermission('read', 'write')).toBeFalsy()
+    expect(actorHasPermission('write', 'admin')).toBeFalsy()
+  })
+
+  test('actor has permission', async () => {
+    expect(actorHasPermission('read', 'none')).toBeTruthy()
+    expect(actorHasPermission('write', 'read')).toBeTruthy()
+    expect(actorHasPermission('admin', 'write')).toBeTruthy()
+    expect(actorHasPermission('write', 'write')).toBeTruthy()
+  })
+
+  test('slash command payload', async () => {
+    const commandWords = ['test', 'arg1', 'arg2', 'arg3']
+    const namedArgs = false
+    const payload: SlashCommandPayload = {
+      command: 'test',
+      args: 'arg1 arg2 arg3',
+      arg1: 'arg1',
+      arg2: 'arg2',
+      arg3: 'arg3'
+    }
+    expect(getSlashCommandPayload(commandWords, namedArgs)).toEqual(payload)
+  })
+
+  test('slash command payload with named args', async () => {
+    const commandWords = ['test', 'branch=master', 'arg1', 'env=prod', 'arg2']
+    const namedArgs = true
+    const payload: SlashCommandPayload = {
+      command: 'test',
+      args: 'branch=master arg1 env=prod arg2',
+      unnamed_args: 'arg1 arg2',
+      branch: 'master',
+      env: 'prod',
+      arg1: 'arg1',
+      arg2: 'arg2'
+    }
+    expect(getSlashCommandPayload(commandWords, namedArgs)).toEqual(payload)
+  })
+
+  test('slash command payload with malformed named args', async () => {
+    const commandWords = ['test', 'branch=', 'arg1', 'e-nv=prod', 'arg2']
+    const namedArgs = true
+    const payload: SlashCommandPayload = {
+      command: 'test',
+      args: 'branch= arg1 e-nv=prod arg2',
+      unnamed_args: 'branch= arg1 e-nv=prod arg2',
+      arg1: 'branch=',
+      arg2: 'arg1',
+      arg3: 'e-nv=prod',
+      arg4: 'arg2'
+    }
+    expect(getSlashCommandPayload(commandWords, namedArgs)).toEqual(payload)
+  })
+})

action.yml

@@ -9,21 +9,28 @@ inputs:
     default: ${{ github.token }}
   reactions:
     description: 'Add reactions to comments containing commands.'
+    default: true
   commands:
     description: 'A comma separated list of commands.'
     required: true
   permission:
     description: 'The repository permission level required by the user to dispatch commands.'
+    default: write
   issue-type:
     description: 'The issue type required for commands.'
+    default: both
   allow-edits:
     description: 'Allow edited comments to trigger command dispatches.'
+    default: false
   repository:
     description: 'The full name of the repository to send the dispatch events.'
+    default: ${{ github.repository }}
   event-type-suffix:
     description: 'The repository dispatch event type suffix for the commands.'
+    default: -command
   named-args:
     description: 'Parse named arguments and add them to the command payload.'
+    default: false
   config:
     description: 'JSON configuration for commands.'
   config-from-file: