resolve package conflicts

Author: typicode

.config/rollup.base.config.mjs

@@ -28,59 +28,67 @@ import {
   resolveId
 } from '../scripts/utils/packages.js'
 
+const require = createRequire(import.meta.url)
+
 const {
   BABEL_RUNTIME,
+  CONSTANTS,
   LATEST,
   ROLLUP_ENTRY_SUFFIX,
   ROLLUP_EXTERNAL_SUFFIX,
   SLASH_NODE_MODULES_SLASH,
+  VENDOR,
   babelConfigPath,
   rootPackageJsonPath,
   rootPath,
   rootSrcPath,
   tsconfigPath
 } = constants
 
-const require = createRequire(import.meta.url)
+const SOCKET_INTEROP = '_socketInterop'
 
-const tsPlugin = require('rollup-plugin-ts')
+const constantsSrcPath = path.join(rootSrcPath, `${CONSTANTS}.ts`)
 
+const babelConfig = require(babelConfigPath)
+const tsPlugin = require('rollup-plugin-ts')
 const rootPackageJson = require(rootPackageJsonPath)
+
 const {
   dependencies: pkgDeps,
   devDependencies: pkgDevDeps,
   overrides: pkgOverrides
 } = rootPackageJson
 
-const SOCKET_INTEROP = '_socketInterop'
-
-const constantsSrcPath = path.join(rootSrcPath, 'constants.ts')
-
 const builtinAliases = builtinModules.reduce((o, n) => {
   o[n] = `node:${n}`
   return o
 }, {})
 
-const babelConfig = require(babelConfigPath)
-
 const customResolver = nodeResolve({
   exportConditions: ['node'],
   preferBuiltins: true
 })
 
 const requireAssignmentsRegExp =
   /(?<=\s*=\s*)require\(["'](?!node:|@socket(?:registry|security)\/|\.).+?["']\)(?=;?\r?\n)/g
+
 const checkRequireAssignmentRegExp = new RegExp(
   requireAssignmentsRegExp.source,
   ''
 )
 const checkSocketInteropUseRegExp = new RegExp(`\\b${SOCKET_INTEROP}\\b`)
+
 const danglingRequiresRegExp = /^\s*require\(["'].+?["']\);?\r?\n/gm
+
 const firstUseStrictRegExp = /'use strict';?/
+
 const oraSpinnersAssignmentsRegExp = /(?<=ora[^.]+\.spinners\s*=\s*)[$\w]+/g
+
 const requireTinyColorsRegExp = /require\(["']tiny-colors["']\)/g
+
 const requireUrlAssignmentRegExp =
   /(?<=var +)[$\w]+(?= *= *require\('node:url'\))/
+
 const splitUrlRequiresRegExp = /require\(["']u["']\s*\+\s*["']rl["']\)/g
 
 function isAncestorsExternal(id, depStats) {
@@ -314,10 +322,10 @@ function ${SOCKET_INTEROP}(e) {
     manualChunks: id_ => {
       const id = normalizeId(id_)
       if (id === constantsSrcPath) {
-        return 'constants'
+        return CONSTANTS
       }
       if (id.includes(SLASH_NODE_MODULES_SLASH)) {
-        return 'vendor'
+        return VENDOR
       }
       return null
     }

.config/rollup.dist.config.mjs

@@ -1,4 +1,10 @@
-import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs'
+import {
+  copyFileSync,
+  existsSync,
+  mkdirSync,
+  rmSync,
+  writeFileSync
+} from 'node:fs'
 import path from 'node:path'
 
 import { globSync as tinyGlobSync } from 'tinyglobby'
@@ -12,6 +18,7 @@ import { isRelative } from '@socketsecurity/registry/lib/path'
 
 import baseConfig from './rollup.base.config.mjs'
 import constants from '../scripts/constants.js'
+import socketModifyPlugin from '../scripts/rollup/socket-modify-plugin.js'
 import { readJsonSync } from '../scripts/utils/fs.js'
 import { formatObject } from '../scripts/utils/objects.js'
 import {
@@ -22,26 +29,48 @@ import {
 
 const {
   BABEL_RUNTIME,
+  CONSTANTS,
+  MODULE_SYNC,
+  REQUIRE,
   ROLLUP_EXTERNAL_SUFFIX,
+  VENDOR,
   depStatsPath,
   rootDistPath,
   rootPath,
   rootSrcPath
 } = constants
 
-const CONSTANTS_JS = 'constants.js'
-const CONSTANTS_STUB_CODE = `'use strict'\n\nmodule.exports = require('../${CONSTANTS_JS}')\n`
+const CONSTANTS_JS = `${CONSTANTS}.js`
+const CONSTANTS_STUB_CODE = createStubCode(`../${CONSTANTS_JS}`)
+const VENDOR_JS = `${VENDOR}.js`
 
 const distConstantsPath = path.join(rootDistPath, CONSTANTS_JS)
-const distModuleSyncPath = path.join(rootDistPath, 'module-sync')
-const distRequirePath = path.join(rootDistPath, 'require')
+const distModuleSyncPath = path.join(rootDistPath, MODULE_SYNC)
+const distRequirePath = path.join(rootDistPath, REQUIRE)
 
 const editablePkgJson = readPackageJsonSync(rootPath, { editable: true })
 
-function removeDtsFilesSync(distPath) {
-  for (const filepath of tinyGlobSync(['**/*.d.ts'], {
+const processEnvTapRegExp =
+  /\bprocess\.env(?:\.TAP|\[['"]TAP['"]\])(\s*\?[^:]+:\s*)?/g
+
+function createStubCode(relFilepath) {
+  return `'use strict'\n\nmodule.exports = require('${relFilepath}')\n`
+}
+
+function moveDtsFilesSync(namePattern, srcPath, destPath) {
+  for (const filepath of tinyGlobSync([`**/${namePattern}.d.ts{.map,}`], {
+    absolute: true,
+    cwd: srcPath
+  })) {
+    copyFileSync(filepath, path.join(destPath, path.basename(filepath)))
+    rmSync(filepath)
+  }
+}
+
+function removeDtsFilesSync(namePattern, srcPath) {
+  for (const filepath of tinyGlobSync([`**/${namePattern}.d.ts{.map,}`], {
     absolute: true,
-    cwd: distPath
+    cwd: srcPath
   })) {
     rmSync(filepath)
   }
@@ -127,12 +156,13 @@ export default () => {
     plugins: [
       {
         generateBundle(_options, bundle) {
-          const constantsBundle = bundle[CONSTANTS_JS]
-          if (constantsBundle) {
-            mkdirSync(rootDistPath, { recursive: true })
-            writeFileSync(distConstantsPath, constantsBundle.code, 'utf8')
-            bundle[CONSTANTS_JS].code = CONSTANTS_STUB_CODE
+          const data = bundle[CONSTANTS_JS]
+          if (data?.type === 'chunk') {
+            data.code = CONSTANTS_STUB_CODE
           }
+        },
+        writeBundle() {
+          removeDtsFilesSync(CONSTANTS, distModuleSyncPath)
         }
       }
     ]
@@ -156,14 +186,33 @@ export default () => {
       }
     ],
     plugins: [
+      // When process.env['TAP'] is found either remove it, if part of a ternary
+      // operation, or replace it with `false`.
+      socketModifyPlugin({
+        find: processEnvTapRegExp,
+        replace: (_match, ternary) => (ternary ? '' : 'false')
+      }),
       {
         generateBundle(_options, bundle) {
-          if (bundle[CONSTANTS_JS]) {
-            bundle[CONSTANTS_JS].code = CONSTANTS_STUB_CODE
+          for (const basename of Object.keys(bundle)) {
+            const data = bundle[basename]
+            if (data.type === 'chunk') {
+              if (basename === CONSTANTS_JS) {
+                mkdirSync(rootDistPath, { recursive: true })
+                writeFileSync(distConstantsPath, data.code, 'utf8')
+                data.code = CONSTANTS_STUB_CODE
+              } else if (
+                basename !== VENDOR_JS &&
+                !data.code.includes(`'./${VENDOR_JS}'`)
+              ) {
+                data.code = createStubCode(`../${MODULE_SYNC}/${basename}`)
+              }
+            }
           }
         },
         writeBundle() {
-          removeDtsFilesSync(distRequirePath)
+          moveDtsFilesSync(CONSTANTS, distRequirePath, rootDistPath)
+          removeDtsFilesSync('*', distRequirePath)
           updateDepStatsSync(requireConfig.meta.depStats)
         }
       }

.config/rollup.test.config.mjs

@@ -18,10 +18,10 @@ const {
 
 export default () =>
   baseConfig({
-    input: {
-      misc: `${rootSrcPath}/utils/misc.ts`,
-      'path-resolve': `${rootSrcPath}/utils/path-resolve.ts`
-    },
+    input: ['alert/rules', 'errors', 'path-resolve'].reduce((o, k) => {
+      o[k.replaceAll('/', '-')] = `${rootSrcPath}/utils/${k}.ts`
+      return o
+    }, {}),
     output: [
       {
         dir: 'test/dist',

.ncurc.json

@@ -0,0 +1,5 @@
+{
+  "loglevel": "minimal",
+  "reject": ["has-flag", "terminal-link", "typescript"],
+  "upgrade": true
+}

README.md

@@ -117,7 +117,7 @@ use of the `projectIgnorePaths` to excludes files when creating a report.
 
 ## Environment variables
 
-- `SOCKET_SECURITY_API_KEY` - if set, this will be used as the API-key
+- `SOCKET_SECURITY_API_TOKEN` - if set, this will be used as the API-key
 
 ## Contributing
 

bin/cli.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 'use strict'
 
+const process = require('node:process')
+
 const constants = require('../dist/constants')
 
 const { DIST_TYPE } = constants

eslint.config.js

@@ -100,7 +100,8 @@ function getImportXFlatConfigs(isEsm) {
         // TypeScript compilation already ensures that named imports exist in
         // the referenced module.
         'import-x/named': 'off',
-        'import-x/no-named-as-default-member': 'off'
+        'import-x/no-named-as-default-member': 'off',
+        'import-x/no-unresolved': 'off'
       }
     }
   }
@@ -121,17 +122,9 @@ module.exports = [
     ...importFlatConfigsForModule.recommended
   },
   {
-    files: ['src/**/*.ts'],
+    files: ['src/**/*.ts', 'test/**/*.ts'],
     ...importFlatConfigsForModule.typescript
   },
-  {
-    files: ['test/**/*.ts'],
-    ...importFlatConfigsForModule.typescript,
-    rules: {
-      ...importFlatConfigsForModule.typescript.rules,
-      'import-x/no-unresolved': 'off'
-    }
-  },
   {
     files: ['src/**/*.ts', 'test/**/*.ts'],
     languageOptions: {

scripts/constants.js

@@ -9,9 +9,13 @@ const {
   [kInternalsSymbol]: { createConstantsObject }
 } = registryConstants
 
+const CONSTANTS = 'constants'
+const MODULE_SYNC = 'module-sync'
+const REQUIRE = 'require'
 const ROLLUP_ENTRY_SUFFIX = '?commonjs-entry'
 const ROLLUP_EXTERNAL_SUFFIX = '?commonjs-external'
 const SLASH_NODE_MODULES_SLASH = '/node_modules/'
+const VENDOR = 'vendor'
 
 const lazyBabelConfigPath = () =>
   // Lazily access constants.rootConfigPath.
@@ -45,9 +49,13 @@ const lazyTsconfigPath = () =>
 
 const constants = createConstantsObject(
   {
+    CONSTANTS,
+    MODULE_SYNC,
+    REQUIRE,
     ROLLUP_ENTRY_SUFFIX,
     ROLLUP_EXTERNAL_SUFFIX,
     SLASH_NODE_MODULES_SLASH,
+    VENDOR,
     babelConfigPath: undefined,
     depStatsPath: undefined,
     rootConfigPath: undefined,

src/cli.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { pathToFileURL } from 'node:url'
 
 import { messageWithCauses, stackWithCauses } from 'pony-cause'
@@ -8,8 +9,8 @@ import colors from 'yoctocolors-cjs'
 
 import * as cliCommands from './commands'
 import constants from './constants'
-import { logSymbols } from './utils/color-or-markdown'
 import { AuthError, InputError } from './utils/errors'
+import { logSymbols } from './utils/logging'
 import { meowWithSubcommands } from './utils/meow-with-subcommands'
 
 const { rootPkgJsonPath } = constants

src/commands/analytics.ts

@@ -14,13 +14,10 @@ import colors from 'yoctocolors-cjs'
 import { Spinner } from '@socketsecurity/registry/lib/spinner'
 
 import { commonFlags, outputFlags } from '../flags'
-import {
-  handleApiCall,
-  handleUnsuccessfulApiResponse
-} from '../utils/api-helpers'
+import { handleApiCall, handleUnsuccessfulApiResponse } from '../utils/api'
 import { AuthError, InputError } from '../utils/errors'
-import { printFlagList } from '../utils/formatting'
-import { getDefaultKey, setupSdk } from '../utils/sdk'
+import { getFlagListOutput } from '../utils/output-formatting'
+import { getDefaultToken, setupSdk } from '../utils/sdk'
 
 import type { CliSubcommand } from '../utils/meow-with-subcommands'
 
@@ -32,7 +29,7 @@ export const analytics: CliSubcommand = {
 
     const input = setupCommand(name, analytics.description, argv, importMeta)
     if (input) {
-      const apiKey = getDefaultKey()
+      const apiKey = getDefaultToken()
       if (!apiKey) {
         throw new AuthError(
           'User must be authenticated to run this command. To log in, run the command `socket login` and enter your API key.'
@@ -117,7 +114,7 @@ function setupCommand(
       $ ${name} --scope=<scope> --time=<time filter>
 
     Options
-      ${printFlagList(flags, 6)}
+      ${getFlagListOutput(flags, 6)}
 
     Examples
       $ ${name} --scope=org --time=7