feat: v2 to main (#367)

* Updates for `sf` (#34)

* feat: support sf

BREAKING CHANGE: only works for sf now

* test: update to work with new file structure

* refactor: use oclif/core

* chore: bump to 2.0.0

* chore: satisfy dev-scripts

* chore: code review

* chore: regenerate yarn.lock

* chore(release): 2.0.0 [ci skip]

* fix: use this.config

* chore(release): 2.0.1 [ci skip]

* chore: update circle config for v2 [skip ci]

* fix: update generate command reference

* chore(release): 2.0.2 [ci skip]

* fix: populate topic command xml

* chore(release): 2.0.3 [ci skip]

* fix: append suffix to all filenames

* test: update filenames

* chore(release): 2.0.4 [ci skip]

* fix: use unique id

* chore(release): 2.0.5 [ci skip]

* fix: don't generate xml for topics

* chore(release): 2.0.6 [ci skip]

* fix: improve error handling

* chore(release): 2.0.7 [ci skip]

* fix: update template files for sf

* update help file for "sf"

* update sf page that lists the plugin versions

* tweaks to command topics for "sf"

* tweaks to topic ditamaps for "sf"

* fix: update test with new title in command XML file

* chore(release): 2.0.8 [ci skip]

* fix: use latest sf-plugins-core

* chore(release): 2.0.9 [ci skip]

* fix: change title/shortdesc of main ditamap so it says "sf"

* chore(release): 2.0.10 [ci skip]

* fix: stop generating main topic intro

* chore(release): 2.0.11 [ci skip]

* fix: bump to GA deps (#37)

* chore(release): 2.0.12 [ci skip]

* feat: add --all (#38)

* chore(release): 2.1.0 [ci skip]

* chore: fix and run windows unit tests

* chore(release): 2.1.1 [ci skip]

* feat: update dependencies

* chore: add main to package.json

* chore(release): 2.2.0 [ci skip]

* fix: dont run default functions

* chore(release): 2.2.1 [ci skip]

* fix: remove cli-ux reference

* chore(release): 2.2.2 [ci skip]

* fix: prevent empty tags

* chore(release): 2.2.3 [ci skip]

* fix: escape tags

* chore(release): 2.2.4 [ci skip]

* fix: remove duplicates

* fix: refine default value

* chore(release): 2.2.5 [ci skip]

* fix: remove async handlebars

* chore(release): 2.2.6 [ci skip]

* fix: default value

* chore(release): 2.2.7 [ci skip]

* chore: remove .tgz [skip ci]

* fix: remove console.log

* chore(release): 2.2.8 [ci skip]

* fix: improve types (#99)

* fix: improve types

* chore: regenerate yarn.lock

* fix: description no longer required for sf

@W-12296410@

* Revert "fix: description no longer required for sf"

This reverts commit 1a4774c.

* fix: description no longer required for sf

@W-12296410@

* fix: add GHA folder

@W-0@

* chore: changes

* chore: apply requested changes

* chore(release): 2.2.9 [skip ci]

* fix: check if plugin exists

* chore(release): 2.2.10 [skip ci]

* feat: use oclif/core v2

* chore(release): 2.3.0 [skip ci]

* fix: duplicate flag descriptions

* chore(release): 2.3.1 [skip ci]

* feat: jit install command (#265)

* feat: add jit install command

* chore: simplify implementation

* chore(release): 2.4.0 [skip ci]

* fix: jit install

* chore(release): 2.4.1 [skip ci]

* fix: add strict null checks

@W-12220467@
changed ref plugin to plugin-auth

* chore: remove unneeded case

* refactor: rid project of fs-extra

* chore: apply review suggestions

* refactor: get rid of json map

* chore: apply changes from review

* chore(release): 2.4.2 [skip ci]

* Revert "Merge pull request #330 from salesforcecli/phale/strict-null-checks"

This reverts commit 5e0240f, reversing
changes made to d730f40.

# Conflicts:
#	package.json

* fix: revert 2.4.2

* chore(release): 2.4.4 [skip ci]

* fix: render cmd and flag sum/desc ejs template (#350)

* chore(release): 2.4.5 [skip ci]

* fix: don't overwrite commands with equivalent topics in other plugins

* chore: better progress

* chore: wip

* refactor: narrower types and stronger type checking

@W-13138789@

* chore: fix tests after merge

* chore: reapply stash

* chore: wireit updates

* test: e2e tests generate test files first

* refactor: typeguard in place of assertion

* fix: binary is on commandMeta, not command

* fix: merge subtopics, use maps

* fix: config replacements in descriptions

* fix: use the correct ensureArray

* docs: readme

* refactor: reduce ts workarounds

* chore: remove unused code

* fix: missing commands where there was a topic collision

* chore: gitignore for my output files

* refactor: remove unused

---------

Co-authored-by: Peter Hale <peter.hale@salesforce.com>

* chore(release): 2.4.6 [skip ci]

* ci: merge v2 into main

* chore: bye, circle

* style: remove comments

* fix: misapplied change from merge

* chore: remove commen

---------

Co-authored-by: Mike Donnalley <mdonnalley@salesforce.com>
Co-authored-by: SF-CLI-BOT <alm-cli@salesforce.com>
Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com>
Co-authored-by: Rodrigo Espinosa de los Monteros <1084688+RodEsp@users.noreply.github.com>
Co-authored-by: Peter Hale <peter.hale@salesforce.com>
Co-authored-by: peternhale <peternhale@users.noreply.github.com>
Co-authored-by: Willhoit <iowillhoit@users.noreply.github.com>
Co-authored-by: svc-cli-bot <svc_cli_bot@salesforce.com>
Co-authored-by: Cristian Dominguez <6853656+cristiand391@users.noreply.github.com>

.eslintrc.js

@@ -5,14 +5,18 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 module.exports = {
-  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license'],
+  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license', 'plugin:sf-plugin/recommended'],
   rules: {
-    '@typescript-eslint/no-explicit-any': 'warn',
-    '@typescript-eslint/explicit-function-return-type': 'warn',
-    '@typescript-eslint/restrict-template-expressions': 'warn',
-    '@typescript-eslint/no-unsafe-assignment': 'warn',
-    '@typescript-eslint/no-unsafe-member-access': 'warn',
-    '@typescript-eslint/no-unsafe-call': 'warn',
-    '@typescript-eslint/no-unsafe-return': 'warn',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/member-ordering': 'off',
+    'no-underscore-dangle': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    'no-empty': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
   },
 };

.github/workflows/notify-slack-on-pr-open.yml

@@ -8,16 +8,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Notify Slack on PR open
-      env: 
-        WEBHOOK_URL : ${{ secrets.CLI_TEAM_SLACK_WEBHOOK_URL }}
-        PULL_REQUEST_AUTHOR_ICON_URL : ${{ github.event.pull_request.user.avatar_url }}
-        PULL_REQUEST_AUTHOR_NAME : ${{ github.event.pull_request.user.login }}
-        PULL_REQUEST_AUTHOR_PROFILE_URL: ${{ github.event.pull_request.user.html_url }}
-        PULL_REQUEST_BASE_BRANCH_NAME : ${{ github.event.pull_request.base.ref }}
-        PULL_REQUEST_COMPARE_BRANCH_NAME : ${{ github.event.pull_request.head.ref }}
-        PULL_REQUEST_NUMBER : ${{ github.event.pull_request.number }}
-        PULL_REQUEST_REPO: ${{ github.event.pull_request.head.repo.name }}
-        PULL_REQUEST_TITLE : ${{ github.event.pull_request.title }}
-        PULL_REQUEST_URL : ${{ github.event.pull_request.html_url }}
-      uses: salesforcecli/github-workflows/.github/actions/prNotification@main
+      - name: Notify Slack on PR open
+        env:
+          WEBHOOK_URL: ${{ secrets.CLI_TEAM_SLACK_WEBHOOK_URL }}
+          PULL_REQUEST_AUTHOR_ICON_URL: ${{ github.event.pull_request.user.avatar_url }}
+          PULL_REQUEST_AUTHOR_NAME: ${{ github.event.pull_request.user.login }}
+          PULL_REQUEST_AUTHOR_PROFILE_URL: ${{ github.event.pull_request.user.html_url }}
+          PULL_REQUEST_BASE_BRANCH_NAME: ${{ github.event.pull_request.base.ref }}
+          PULL_REQUEST_COMPARE_BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
+          PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}
+          PULL_REQUEST_REPO: ${{ github.event.pull_request.head.repo.name }}
+          PULL_REQUEST_TITLE: ${{ github.event.pull_request.title }}
+          PULL_REQUEST_URL: ${{ github.event.pull_request.html_url }}
+        uses: salesforcecli/github-workflows/.github/actions/prNotification@main

.github/workflows/onPushToMain.yml

@@ -9,10 +9,3 @@ jobs:
   release:
     uses: salesforcecli/github-workflows/.github/workflows/githubRelease.yml@main
     secrets: inherit
-
-  # most repos won't use this
-  # depends on previous job to avoid git collisions, not for any functionality reason
-  # docs:
-  #   uses: salesforcecli/github-workflows/.github/workflows/publishTypedoc.yml@main
-  #   secrets: inherit
-  #   needs: release

.github/workflows/onRelease.yml

@@ -14,8 +14,5 @@ jobs:
   npm:
     uses: salesforcecli/github-workflows/.github/workflows/npmPublish.yml@main
     with:
-      # ternary-ish https://github.com/actions/runner/issues/409#issuecomment-752775072
-      # if the version is 2.x we release it on the `sf` dist tag
-      tag: ${{ startsWith( github.event.release.tag_name || inputs.tag, '1.') && 'latest' || 'sf'}}
       githubTag: ${{ github.event.release.tag_name || inputs.tag }}
     secrets: inherit

.github/workflows/test.yml

@@ -10,3 +10,6 @@ jobs:
   linux-unit-tests:
     needs: yarn-lockfile-check
     uses: salesforcecli/github-workflows/.github/workflows/unitTestsLinux.yml@main
+  windows-unit-tests:
+    needs: linux-unit-tests
+    uses: salesforcecli/github-workflows/.github/workflows/unitTestsWindows.yml@main

.gitignore

@@ -1,10 +1,48 @@
-*-debug.log
-*-error.log
-/.nyc_output
-/dist
-/lib
-/package-lock.json
+# -- CLEAN
+
+# use yarn by default, so ignore npm
+package-lock.json
+
+# never checkin npm config
+.npmrc
+
+# debug logs
+npm-error.log
+yarn-error.log
+lerna-debug.log
+*.tsbuildinfo
+
+# compile source
+lib
+
+# test artifacts
+*xunit.xml
+*checkstyle.xml
+*unitcoverage
+.nyc_output
+coverage
+
+# generated docs
+docs
+output*
+
+# -- CLEAN ALL
+.eslintcache
+.wireit
+node_modules
+
+# --
+# put files here you don't want cleaned with sf-clean
+
+# os specific files
+.DS_Store
+.idea
+
+# ignore sfdx-trust files
+*.tgz
+*.sig
+package.json.bak.
+
 /tmp
 /test/tmp
-node_modules
 oclif.manifest.json

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn build && yarn test
+yarn build && yarn test --forbid-only

.nycrc

@@ -2,4 +2,4 @@
   "nyc": {
     "extends": "@salesforce/dev-config/nyc"
   }
-}
+}

.sfdevrc.json

@@ -0,0 +1,25 @@
+{
+  "test": {
+    "testsPath": "test/**/*.test.ts"
+  },
+  "wireit": {
+    "test:command-reference": {
+      "command": "\"./bin/dev\" commandreference:generate --plugins auth --outputdir test/tmp",
+      "files": ["src/**/*.ts", "messages/**", "package.json"],
+      "output": ["test/tmp"]
+    },
+    "test": {
+      "dependencies": ["test:compile", "test:only", "lint"]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": ["test/**/*.ts", "src/**/*.ts", "**/tsconfig.json", ".mocha*", "!*.nut.ts", ".nycrc"],
+      "output": [],
+      "dependencies": ["test:command-reference"]
+    }
+  },
+  "exclude-scripts": ["pretest"]
+}