Merge branch 'master' into no-envars

Author: 0x2b3bfa0

.github/workflows/test-deploy.yml

@@ -104,10 +104,9 @@ jobs:
       - run: npm ${{ inputs.release && 'publish' || 'publish --dry-run' }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - run: |
-          sudo apt install --yes libplist-dev
-          git clone --branch v2.1.5 git://git.saurik.com/ldid.git
-          sudo g++ -pipe -o /usr/bin/ldid ldid/ldid.cpp -I. -x c ldid/{lookup2.c,sha1.h} -lplist -lcrypto
+      # Step required "thanks" to https://github.com/actions/runner-images/issues/6283
+      - uses: Homebrew/actions/setup-homebrew@29b2973f18e5aca5443f4b3d87f68eda7a27b22b
+      - run: brew install ldid
       - run: |
           cp node_modules/@npcz/magic/dist/magic.mgc assets/magic.mgc
           npx --yes pkg --no-bytecode --public-packages "*" --public package.json

Dockerfile

@@ -116,6 +116,8 @@ WORKDIR ${CML_RUNNER_PATH}
 # SET SPECIFIC ENVIRONMENT VARIABLES
 ENV IN_DOCKER=1
 ENV RUNNER_ALLOW_RUNASROOT=1
+# Environment variable used by cml to detect it's been installed using the docker image.
+ENV _CML_CONTAINER_IMAGE=true
 
 # DEFINE ENTRY POINT AND COMMAND
 # Smart entrypoint understands commands like `bash` or `/bin/sh` but defaults to `cml`;

bin/cml.js

@@ -48,7 +48,6 @@ const setupOpts = (opts) => {
 
   const { markdownfile } = opts;
   opts.markdownFile = markdownfile;
-  opts.cmlCommand = opts._[0];
   opts.cml = new CML(opts);
 };
 
@@ -76,9 +75,29 @@ const setupLogger = (opts) => {
   });
 };
 
-const setupTelemetry = async (opts) => {
-  const { cml, cmlCommand: action } = opts;
-  opts.telemetryEvent = await jitsuEventPayload({ action, cml });
+const setupTelemetry = async (opts, yargs) => {
+  const { cml, _: command } = opts;
+
+  const options = {};
+  for (const [name, option] of Object.entries(opts.options)) {
+    // Skip options with default values (i.e. not explicitly set by users)
+    if (opts[name] && !yargs.parsed.defaulted[name]) {
+      switch (option.telemetryData) {
+        case 'name':
+          options[name] = null;
+          break;
+        case 'full':
+          options[name] = opts[name];
+          break;
+      }
+    }
+  }
+
+  opts.telemetryEvent = await jitsuEventPayload({
+    action: command.join(':'),
+    extra: { options },
+    cml
+  });
 };
 
 const runPlugin = async ({ $0: executable, command }) => {
@@ -99,6 +118,7 @@ const handleError = (message, error) => {
 
 (async () => {
   setupLogger({ log: 'debug' });
+
   try {
     await yargs
       .env('CML')

bin/cml/asset/publish.js

@@ -23,7 +23,11 @@ exports.handler = async (opts) => {
   else await fs.writeFile(file, output);
 };
 
-exports.builder = (yargs) => yargs.env('CML_ASSET').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_ASSET')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   url: {
@@ -51,7 +55,8 @@ exports.options = kebabcaseKeys({
   },
   rmWatermark: {
     type: 'boolean',
-    description: 'Avoid CML watermark.'
+    description: 'Avoid CML watermark.',
+    telemetryData: 'name'
   },
   mimeType: {
     type: 'string',

bin/cml/check/create.js

@@ -10,7 +10,11 @@ exports.handler = async (opts) => {
   await cml.checkCreate({ ...opts, report });
 };
 
-exports.builder = (yargs) => yargs.env('CML_CHECK').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_CHECK')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   token: {

bin/cml/comment/create.js

@@ -8,7 +8,11 @@ exports.handler = async (opts) => {
   console.log(await cml.commentCreate(opts));
 };
 
-exports.builder = (yargs) => yargs.env('CML_COMMENT').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_COMMENT')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   pr: {
@@ -30,7 +34,8 @@ exports.options = kebabcaseKeys({
   publishUrl: {
     type: 'string',
     default: 'https://asset.cml.dev',
-    description: 'Self-hosted image server URL'
+    description: 'Self-hosted image server URL',
+    telemetryData: 'name'
   },
   watch: {
     type: 'boolean',
@@ -44,7 +49,8 @@ exports.options = kebabcaseKeys({
   native: {
     type: 'boolean',
     description:
-      "Uses driver's native capabilities to upload assets instead of CML's storage; not available on GitHub"
+      "Uses driver's native capabilities to upload assets instead of CML's storage; not available on GitHub",
+    telemetryData: 'name'
   },
   update: {
     type: 'boolean',
@@ -55,6 +61,7 @@ exports.options = kebabcaseKeys({
   rmWatermark: {
     type: 'boolean',
     description:
-      'Avoid watermark; CML needs a watermark to be able to distinguish CML comments from others'
+      'Avoid watermark; CML needs a watermark to be able to distinguish CML comments from others',
+    telemetryData: 'name'
   }
 });

bin/cml/pr.js

@@ -16,5 +16,6 @@ exports.builder = (yargs) =>
         ])
       )
     )
+    .option('options', { default: options, hidden: true })
     .check(({ globpath }) => globpath)
     .strict();

bin/cml/pr/create.js

@@ -15,7 +15,11 @@ exports.handler = async (opts) => {
   console.log(link);
 };
 
-exports.builder = (yargs) => yargs.env('CML_PR').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_PR')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   md: {

bin/cml/repo/prepare.js

@@ -10,7 +10,11 @@ exports.handler = async (opts) => {
   await cml.ci(opts);
 };
 
-exports.builder = (yargs) => yargs.env('CML_REPO').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_REPO')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   unshallow: {

bin/cml/runner.js

@@ -16,5 +16,6 @@ exports.builder = (yargs) =>
         ])
       )
     )
+    .option('options', { default: options, hidden: true })
     .check(() => process.argv.some((arg) => arg.startsWith('-')))
     .strict();