Adding more missing files and settings from module-template

.depcheckrc.json

@@ -0,0 +1,10 @@
+{
+  "ignores": [
+    "@lavamoat/allow-scripts",
+    "@lavamoat/preinstall-always-fail",
+    "@metamask/auto-changelog",
+    "@types/*",
+    "prettier-plugin-packagejson",
+    "ts-node"
+  ]
+}

.gitattributes

@@ -1,3 +1,8 @@
 * text=auto
 
 yarn.lock linguist-generated=false
+
+# yarn v3
+# See: https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+/.yarn/releases/** binary
+/.yarn/plugins/** binary

.yarnrc.yml

@@ -10,8 +10,8 @@ nodeLinker: node-modules
 
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs
-    spec: "https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js"
+    spec: 'https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js'
   - path: .yarn/plugins/@yarnpkg/plugin-constraints.cjs
-    spec: "@yarnpkg/plugin-constraints"
+    spec: '@yarnpkg/plugin-constraints'
 
 yarnPath: .yarn/releases/yarn-3.2.1.cjs

constraints.pro

@@ -0,0 +1,99 @@
+%===============================================================================
+% Utility predicates
+%===============================================================================
+
+% True if RepoName can be unified with the repository name part of RepoUrl, a
+% complete URL for a repository on GitHub. This URL must include the ".git"
+% extension.
+repo_name(RepoUrl, RepoName) :-
+  Prefix = 'https://github.com/MetaMask/',
+  atom_length(Prefix, PrefixLength),
+  Suffix = '.git',
+  atom_length(Suffix, SuffixLength),
+  atom_length(RepoUrl, RepoUrlLength),
+  sub_atom(RepoUrl, 0, PrefixLength, After, Prefix),
+  sub_atom(RepoUrl, Before, SuffixLength, 0, Suffix),
+  Start is RepoUrlLength - After + 1,
+  End is Before + 1,
+  RepoNameLength is End - Start,
+  sub_atom(RepoUrl, PrefixLength, RepoNameLength, SuffixLength, RepoName).
+
+%===============================================================================
+% Constraints
+%===============================================================================
+
+% The package must have a name.
+\+ gen_enforced_field(WorkspaceCwd, 'name', null).
+
+% The package must have a description.
+\+ gen_enforced_field(WorkspaceCwd, 'description', null).
+% The description cannot end with a period.
+gen_enforced_field(WorkspaceCwd, 'description', DescriptionWithoutTrailingPeriod) :-
+  workspace_field(WorkspaceCwd, 'description', Description),
+  atom_length(Description, Length),
+  LengthLessOne is Length - 1,
+  sub_atom(Description, LengthLessOne, 1, 0, LastCharacter),
+  sub_atom(Description, 0, LengthLessOne, 1, DescriptionWithoutPossibleTrailingPeriod),
+  (
+    LastCharacter == '.' ->
+      DescriptionWithoutTrailingPeriod = DescriptionWithoutPossibleTrailingPeriod ;
+      DescriptionWithoutTrailingPeriod = Description
+  ).
+
+% The homepage of the package must match its name (which is in turn based on its
+% workspace directory name).
+gen_enforced_field(WorkspaceCwd, 'homepage', CorrectHomepageUrl) :-
+  workspace_field(WorkspaceCwd, 'repository.url', RepoUrl),
+  repo_name(RepoUrl, RepoName),
+  atomic_list_concat(['https://github.com/MetaMask/', RepoName, '#readme'], CorrectHomepageUrl).
+
+% The bugs URL of the package must point to the Issues page for the repository.
+gen_enforced_field(WorkspaceCwd, 'bugs.url', CorrectBugsUrl) :-
+  \+ workspace_field(WorkspaceCwd, 'private', true),
+  workspace_field(WorkspaceCwd, 'repository.url', RepoUrl),
+  repo_name(RepoUrl, RepoName),
+  atomic_list_concat(['https://github.com/MetaMask/', RepoName, '/issues'], CorrectBugsUrl).
+
+% The package must specify Git as the repository type.
+gen_enforced_field(WorkspaceCwd, 'repository.type', 'git').
+
+% The package must match the URL of a repo within the MetaMask organization.
+gen_enforced_field(WorkspaceCwd, 'repository.url', 'https://github.com/MetaMask/<insert repo name here>.git') :-
+  workspace_field(WorkspaceCwd, 'repository.url', RepoUrl),
+  \+ repo_name(RepoUrl, _).
+
+% The license for the package must be specified.
+gen_enforced_field(WorkspaceCwd, 'license').
+
+% The type definitions entrypoint the package must be `./dist/types/index.d.ts`.
+gen_enforced_field(WorkspaceCwd, 'types', './dist/types/index.d.ts').
+gen_enforced_field(WorkspaceCwd, 'exports["."].types', './dist/types/index.d.ts').
+
+% The entrypoint for the package must be `./dist/index.js`.
+gen_enforced_field(WorkspaceCwd, 'main', './dist/index.js').
+gen_enforced_field(WorkspaceCwd, 'exports["."].require', './dist/index.js').
+
+% The module entrypoint for the package must be `./dist/index.mjs`.
+gen_enforced_field(WorkspaceCwd, 'module', './dist/index.mjs').
+gen_enforced_field(WorkspaceCwd, 'exports["."].import', './dist/index.mjs').
+
+gen_enforced_field(WorkspaceCwd, 'exports["./package.json"]', './package.json').
+
+% The list of files included in the package must only include files generated
+% during the build step.
+gen_enforced_field(WorkspaceCwd, 'files', ['dist']).
+
+% If a dependency is listed under "dependencies", it should not be listed under
+% "devDependencies".
+gen_enforced_dependency(WorkspaceCwd, DependencyIdent, null, DependencyType) :-
+  workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'dependencies'),
+  workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, DependencyType),
+  DependencyType == 'devDependencies'.
+
+% The package must specify the expected node version constraint.
+gen_enforced_field(WorkspaceCwd, 'engines.node', '^18.18 || >=20').
+
+% The package is public.
+gen_enforced_field(WorkspaceCwd, 'publishConfig.access', 'public').
+% The package is available on the NPM registry.
+gen_enforced_field(WorkspaceCwd, 'publishConfig.registry', 'https://registry.npmjs.org/').

jest.config.js

@@ -1,13 +1,48 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
 module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/fk/c3y07g0576j8_2s9m01pk4qw0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances and results before every test.
+  // This does not remove any mock implementation that may have been provided,
+  // so we disable it.
+  // clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
   collectCoverage: true,
-  // Ensures that we collect coverage from all source files, not just tested
-  // ones.
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
   collectCoverageFrom: [
     './src/**/*.ts',
     '!./src/**/*index.ts',
     '!./src/js/colors/colors.ts',
   ],
-  coverageReporters: ['text', 'html'],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'babel',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  coverageReporters: ['html', 'json-summary', 'text'],
+
+  // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
       branches: 100,
@@ -16,16 +51,158 @@ module.exports = {
       statements: 100,
     },
   },
-  moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
   preset: 'ts-jest',
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
   // "resetMocks" resets all mocks, including mocked modules, to jest.fn(),
   // between each test case.
   resetMocks: true,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
   // "restoreMocks" restores all mocks created using jest.spyOn to their
   // original implementations, between each test. It does not affect mocked
   // modules.
   restoreMocks: true,
-  testEnvironment: 'node',
-  testRegex: ['\\.test\\.(ts|js)$'],
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // Reduce the default test timeout from 5s to 2.5s
   testTimeout: 2500,
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
 };

scripts/get.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+set -e
+set -u
+set -o pipefail
+
+if [[ ${RUNNER_DEBUG:-0} == 1 ]]; then
+  set -x
+fi
+
+KEY="${1}"
+OUTPUT="${2}"
+
+if [[ -z $KEY ]]; then
+  echo "Error: KEY not specified."
+  exit 1
+fi
+
+if [[ -z $OUTPUT ]]; then
+  echo "Error: OUTPUT not specified."
+  exit 1
+fi
+
+echo "$OUTPUT=$(jq --raw-output "$KEY" package.json)" >> "$GITHUB_OUTPUT"

scripts/prepack.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+set -o pipefail
+
+if [[ -n $SKIP_PREPACK ]]; then
+  echo "Notice: skipping prepack."
+  exit 0
+fi
+
+yarn build