Shared scripts: @lg-tools/slackbot

.changeset/poor-cheetahs-pretend.md

@@ -0,0 +1,5 @@
+---
+'@lg-tools/slackbot': minor
+---
+
+First pre-release of LeafyGreen slackbot

package.json

@@ -24,7 +24,7 @@
     "prepublish:ts-downlevel": "rm -rf packages/*/dist/ts3.4 && echo packages/*/dist | NODE_NO_WARNINGS=1 xargs -I{} -n1 -P8 downlevel-dts {} {}/ts3.4",
     "publish": "npm-run-all --serial publish:*",
     "publish:packages": "yarn changeset publish --public",
-    "slackbot": "npx ts-node ./scripts/slackbot",
+    "slackbot": "slackbot",
     "start": "storybook dev -p 9001 --no-version-updates",
     "test": "lg-test",
     "test:ssr": "lg-test --ssr",
@@ -46,9 +46,9 @@
     "@leafygreen-ui/testing-lib": "*",
     "@lg-tools/build": "^0.0.1",
     "@lg-tools/lint": "^0.0.1",
+    "@lg-tools/slackbot": "^0.0.1",
     "@lg-tools/storybook": "^0.0.1",
     "@lg-tools/storybook-decorators": "^0.0.1",
-    "@slack/web-api": "^6.4.0",
     "@tanstack/react-table": "^8.7.3",
     "@types/facepaint": "^1.2.1",
     "@types/highlight.js": "^10.1.0",

tools/slackbot/bin/slackbot.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/index.js');

tools/slackbot/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@lg-tools/slackbot",
+  "version": "0.0.1",
+  "description": "Slackbot for LeafyGreen",
+  "bin": {
+    "slackbot": "./bin/slackbot.js"
+  },
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs",
+    "tsc": "tsc --build tsconfig.json"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@lg-tools/build": "^0.0.1",
+    "@slack/web-api": "^6.4.0",
+    "chalk": "^4.1.2",
+    "commander": "^11.0.0",
+    "lodash": "^4.17.21",
+    "node-fetch": "^2.6.1"
+  }
+}

tools/slackbot/rollup.config.mjs

@@ -0,0 +1,7 @@
+import { umdConfig } from '@lg-tools/build/config/rollup.config.mjs';
+
+const config = {
+  ...umdConfig,
+};
+
+export default config;

scripts/slackbot/slackbot.ts → tools/slackbot/src/slackbot.ts

@@ -9,7 +9,7 @@ import {
   constructBasicUpdateText,
   constructShortUpdateText,
   constructUpdateTextWithChangelog,
-} from './utils/construcUpdateText';
+} from './utils/constructUpdateText';
 import { generateGreeting } from './utils/generateGreeting';
 import { getSortedUpdates } from './utils/getSortedUpdates';
 import {
@@ -20,14 +20,15 @@ import {
 } from './slackbot.types';
 
 const cli = new Command('slackbot')
-  .arguments('<updates>')
+  .arguments('[updates]')
   .option(
     '-c, --channel <channel>',
     'Channel to post to.',
     'leafygreen-ui-releases',
   )
   .option('--test', 'Post to `design-system-testing`', false)
   .option('--dry', 'Dry run. Does not post', false)
+  .option('--verbose', 'Verbose mode', false)
   .parse(process.argv);
 
 cli.addHelpText(
@@ -47,7 +48,7 @@ cli.addHelpText(
 `,
 );
 
-const { channel, test, dry }: Opts = cli.opts();
+const { channel, test, dry, verbose }: Opts = cli.opts();
 
 try {
   /**
@@ -86,7 +87,9 @@ async function slackbot(
   channel: string,
   updates: Array<ComponentUpdateObject>,
 ) {
+  verbose && console.log({ updates, channel });
   const sortedUpdates = await getSortedUpdates(updates);
+  verbose && console.log({ sortedUpdates });
 
   const updateStrings = {
     major:
@@ -115,6 +118,8 @@ async function slackbot(
         : '',
   };
 
+  verbose && console.log({ updateStrings });
+
   const web = new WebClient(botToken);
 
   /** Post to the channel */
@@ -146,7 +151,7 @@ async function slackbot(
       });
     }
   } else {
-    console.warn('Missing message text. Did not send message.');
+    console.warn('No updates to post.');
   }
 }
 

scripts/slackbot/slackbot.types.ts → tools/slackbot/src/slackbot.types.ts

@@ -8,6 +8,7 @@ export interface Opts {
   channel: keyof typeof Channels;
   test: boolean;
   dry: boolean;
+  verbose: boolean;
 }
 
 export interface ComponentUpdateObject {

tools/slackbot/src/utils/test.data.ts

@@ -0,0 +1 @@
+export const TEST_DATA = [{ name: '@leafygreen-ui/example', version: '0.0.0' }];

tools/slackbot/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "@lg-tools/build/config/package.tsconfig.json",
+   "compilerOptions": {
+    "declarationDir": "dist",
+    "outDir": "dist",
+    "rootDir": "src",
+    "baseUrl": "."
+  },
+  "include": [
+    "src/**/*"
+  ]
+}

yarn.lock

@@ -7048,6 +7048,11 @@ combined-stream@^1.0.6, combined-stream@^1.0.8:
   dependencies:
     delayed-stream "~1.0.0"
 
+commander@^11.0.0:
+  version "11.0.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-11.0.0.tgz#43e19c25dbedc8256203538e8d7e9346877a6f67"
+  integrity sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==
+
 commander@^2.18.0, commander@^2.19.0, commander@^2.20.0:
   version "2.20.3"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"