Release 0.2.0

ArmaanT · Jan 6, 2021 · 5ec76cb · 5ec76cb
1 parent 6309e35
commit 5ec76cb
Show file tree

Hide file tree

Showing 15 changed files with 48 additions and 60 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.0 (2021-01-05)
+
+* Migrate from dedent-js to ts-dedent
+* Leave dedent commented out by default in ts init
+* Update js-yaml to 4.0.0 and remove custom yaml formatting workarounds
+
 ## 0.1.4 (2020-12-23)
 
 * Update aws constructs (accidental major bump)

diff --git a/examples/typescript/pypi-publish/.github/cdk/main.ts b/examples/typescript/pypi-publish/.github/cdk/main.ts
@@ -1,4 +1,4 @@
-import * as dedent from 'dedent-js';
+import dedent from 'ts-dedent';
 import { Construct } from "constructs";
 import { App, Stack, Workflow, Job } from "cdkactions";
 

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.1.4"
+  "version": "0.2.0"
 }
diff --git a/package.json b/package.json
@@ -16,8 +16,8 @@
       "examples/**/*"
     ],
     "nohoist": [
-      "cdkactions/dedent-js",
-      "cdkactions/dedent-js/**",
+      "cdkactions/ts-dedent",
+      "cdkactions/ts-dedent/**",
       "cdkactions/js-yaml",
       "cdkactions/js-yaml/**",
       "cdkactions/yaml",

diff --git a/packages/cdkactions-cli/LICENSE b/packages/cdkactions-cli/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Armaan Tobaccowalla
+   Copyright 2021 Armaan Tobaccowalla
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/packages/cdkactions-cli/templates/typescript-app/main.ts b/packages/cdkactions-cli/templates/typescript-app/main.ts
@@ -1,4 +1,4 @@
-import * as dedent from 'dedent-js';
+// import dedent from 'ts-dedent';
 import { Construct } from "constructs";
 import { App, Stack } from "cdkactions";
 

diff --git a/packages/cdkactions/.projenrc.js b/packages/cdkactions/.projenrc.js
@@ -13,10 +13,10 @@ const project = new JsiiProject({
 
   peerDeps: ['constructs'],
   devDeps: ['constructs', '@types/js-yaml'],
-  deps: ['js-yaml', 'dedent-js'],
+  deps: ['js-yaml', 'ts-dedent'],
   bundledDeps: [
     "js-yaml",
-    "dedent-js",
+    "ts-dedent",
   ],
 
   python: {

diff --git a/packages/cdkactions/LICENSE b/packages/cdkactions/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Armaan Tobaccowalla
+   Copyright 2021 Armaan Tobaccowalla
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/packages/cdkactions/package.json b/packages/cdkactions/package.json
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@types/jest": "^26.0.7",
-    "@types/js-yaml": "^3.12.5",
+    "@types/js-yaml": "^4.0.0",
     "@types/node": "^10.17.0",
     "@typescript-eslint/eslint-plugin": "^4.3.0",
     "@typescript-eslint/parser": "^4.3.0",
@@ -57,12 +57,12 @@
     "constructs": "^3.2.80"
   },
   "dependencies": {
-    "dedent-js": "^1.0.1",
-    "js-yaml": "^3.14.1"
+    "js-yaml": "^4.0.0",
+    "ts-dedent": "^2.0.0"
   },
   "bundledDependencies": [
-    "dedent-js",
-    "js-yaml"
+    "js-yaml",
+    "ts-dedent"
   ],
   "keywords": [
     "actions",

diff --git a/packages/cdkactions/src/library.ts b/packages/cdkactions/src/library.ts
@@ -1,5 +1,5 @@
 import { Construct } from 'constructs';
-import * as dedent from 'dedent-js';
+import dedent from 'ts-dedent';
 import { Job, JobProps, StepsProps } from './job';
 import { Stack } from './stack';
 import { Workflow } from './workflow';

diff --git a/packages/cdkactions/src/stack.ts b/packages/cdkactions/src/stack.ts
@@ -2,7 +2,6 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { Construct, ISynthesisSession, Node } from 'constructs';
 import * as yaml from 'js-yaml';
-import { formatGHActionsYaml } from './utils';
 import { Workflow } from './workflow';
 
 /**
@@ -35,11 +34,11 @@ export class Stack extends Construct {
         const workflowOutput = path.join(session.outdir, child.outputFile);
 
         // Get raw yaml of workflow
-        const rawYaml = yaml.safeDump(child.toGHAction(), { lineWidth: -1 });
+        const rawYaml = yaml.dump(child.toGHAction(), { lineWidth: -1, noCompatMode: true, quotingType: '"' });
 
         // Save the formatted yaml
         fs.writeFileSync(workflowOutput, `# Generated by cdkactions. Do not modify\n# Generated as part of the '${this.id}' stack.\n`);
-        fs.writeFileSync(workflowOutput, formatGHActionsYaml(rawYaml), { flag: 'a' });
+        fs.writeFileSync(workflowOutput, rawYaml, { flag: 'a' });
       }
     }
   }

diff --git a/packages/cdkactions/src/utils.ts b/packages/cdkactions/src/utils.ts
@@ -1,33 +1,5 @@
 import { StringMap } from './types';
 
-/**
- * Fix the raw yaml returned by yaml.safeDump by removing quotes surrounding GH Action
- * expressions, removing double single quotes from within a GH Action expression,
- * and finally remove quotes from the top-level "on" key
- * @param rawYaml Raw yaml to be formatted
- */
-export const formatGHActionsYaml = (rawYaml: string) => {
-  // Remove quotes from GH Action expressions: ${{ ... }}
-  const expression_re = /'(\${{ .* }})'/g;
-  const fixedExpression = rawYaml.replace(expression_re, '$1');
-
-  // Remove double single quotes from inside GH Action expressions:
-  const double_re = /\${{ .*''.* }}/g;
-  const removeDoubleQuote = (match: string, _offset: string, _string: string) => {
-    return match.replace(/''/g, '\'');
-  };
-  const fixedDoubleQuotes = fixedExpression.replace(double_re, removeDoubleQuote);
-
-  // Remove quotes from the top-level "on" key
-  const on_re = /'on':/g;
-  const fixedOn = fixedDoubleQuotes.replace(on_re, 'on:');
-
-  // Removes nested single quotes like in "key: '${{ hashFiles('example/yarn.lock') }}'"
-  const nested_re = /: '([^'\n\r]*'[^'\n\r]*'.*)'\n/g;
-  const fixedNested = fixedOn.replace(nested_re, ': $1\n');
-
-  return fixedNested;
-};
 
 /**
  * A helper function to recursively rename keys within an object

diff --git a/packages/cdkactions/test/__snapshots__/synth.test.ts.snap b/packages/cdkactions/test/__snapshots__/synth.test.ts.snap
@@ -21,7 +21,7 @@ jobs:
       - name: Cache
         uses: actions/cache@v2
         with:
-          path: '**/files'
+          path: \\"**/files\\"
           key: v0-\${{ hashFiles('Dockerfile') }}
       - name: Build docker
         uses: docker/build-push-action@v1
@@ -31,7 +31,7 @@ jobs:
           username: \${{ secrets.DOCKER_USERNAME }}
           password: \${{ secrets.DOCKER_PASSWORD }}
           push: \${{ github.ref == 'refs/heads/master' }}
-          tags: 'latest,\${{ github.sha }}'
+          tags: latest,\${{ github.sha }}
         continue-on-error: false
     continue-on-error: false
 "
@@ -55,7 +55,7 @@ exports[`complicated stack 3`] = `
 name: Cron
 on:
   schedule:
-    - cron: '*/15 * * * *'
+    - cron: \\"*/15 * * * *\\"
 jobs:
   matrix:
     runs-on: \${{ matrix.os }}

diff --git a/packages/cdkactions/test/utils.test.ts b/packages/cdkactions/test/utils.test.ts
@@ -1,6 +1,5 @@
 import { camelToSnake, renameKeys } from '../src/utils';
 
-// TODO: test formatGHActionsYaml
 
 test('renameKeys', () => {
   const obj = { oldKey: 'value', arr: [{ oldKey: 'different value' }] };

diff --git a/yarn.lock b/yarn.lock
@@ -1502,10 +1502,10 @@
     jest-diff "^26.0.0"
     pretty-format "^26.0.0"
 
-"@types/js-yaml@^3.12.5":
-  version "3.12.5"
-  resolved "https://registry.yarnpkg.com/@types/js-yaml/-/js-yaml-3.12.5.tgz#136d5e6a57a931e1cce6f9d8126aa98a9c92a6bb"
-  integrity sha512-JCcp6J0GV66Y4ZMDAQCXot4xprYB+Zfd3meK9+INSJeVZwJmHAW30BBEEkPzXswMXuiyReUGOP3GxrADc9wPww==
+"@types/js-yaml@^4.0.0":
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/@types/js-yaml/-/js-yaml-4.0.0.tgz#d1a11688112091f2c711674df3a65ea2f47b5dfb"
+  integrity sha512-4vlpCM5KPCL5CfGmTbpjwVKbISRYhduEJvvUWsH5EB7QInhEj94XPZ3ts/9FPiLZFqYO0xoW4ZL8z2AabTGgJA==
 
 "@types/json-schema@^7.0.3":
   version "7.0.6"
@@ -1829,6 +1829,11 @@ argparse@^1.0.7:
   dependencies:
     sprintf-js "~1.0.2"
 
+argparse@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
+  integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
+
 [email protected]:
   version "0.0.2"
   resolved "https://registry.yarnpkg.com/argv/-/argv-0.0.2.tgz#ecbd16f8949b157183711b1bda334f37840185ab"
@@ -2970,11 +2975,6 @@ decode-uri-component@^0.2.0:
   resolved "https://registry.yarnpkg.com/decode-uri-component/-/decode-uri-component-0.2.0.tgz#eb3913333458775cb84cd1a1fae062106bb87545"
   integrity sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=
 
-dedent-js@^1.0.1:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/dedent-js/-/dedent-js-1.0.1.tgz#bee5fb7c9e727d85dffa24590d10ec1ab1255305"
-  integrity sha1-vuX7fJ5yfYXf+iRZDRDsGrElUwU=
-
 dedent@^0.7.0:
   version "0.7.0"
   resolved "https://registry.yarnpkg.com/dedent/-/dedent-0.7.0.tgz#2495ddbaf6eb874abb0e1be9df22d2e5a544326c"
@@ -5237,14 +5237,21 @@ [email protected]:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
-js-yaml@^3.13.1, js-yaml@^3.14.1:
+js-yaml@^3.13.1:
   version "3.14.1"
   resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537"
   integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==
   dependencies:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
+js-yaml@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.0.0.tgz#f426bc0ff4b4051926cd588c71113183409a121f"
+  integrity sha512-pqon0s+4ScYUvX30wxQi3PogGFAlUyH0awepWvwkj4jD4v+ova3RiYw8bmA6x2rDrEaj8i/oWKoRxpVNW+Re8Q==
+  dependencies:
+    argparse "^2.0.1"
+
 jsbn@~0.1.0:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513"
@@ -8154,6 +8161,11 @@ trim-off-newlines@^1.0.0:
   resolved "https://registry.yarnpkg.com/trim-off-newlines/-/trim-off-newlines-1.0.1.tgz#9f9ba9d9efa8764c387698bcbfeb2c848f11adb3"
   integrity sha1-n5up2e+odkw4dpi8v+sshI8RrbM=
 
+ts-dedent@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/ts-dedent/-/ts-dedent-2.0.0.tgz#47c5eb23d9096f3237cc413bc82d387d36dbe690"
+  integrity sha512-DfxKjSFQfw9+uf7N9Cy8Ebx9fv5fquK4hZ6SD3Rzr+1jKP6AVA6H8+B5457ZpUs0JKsGpGqIevbpZ9DMQJDp1A==
+
 ts-jest@^26.1.0:
   version "26.4.4"
   resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-26.4.4.tgz#61f13fb21ab400853c532270e52cc0ed7e502c49"