From dd695972d18e8e38945b0abc5111ec816bee0766 Mon Sep 17 00:00:00 2001 From: Abraham Williams <4braham@gmail.com> Date: Sat, 19 Feb 2022 11:00:35 -0600 Subject: [PATCH] Switch to ESM --- .eslintrc.js => .eslintrc.cjs | 0 bin.js | 7 +- index.js | 10 +- index.test.js | 8 +- jest.config.mjs | 194 ++++++++++++++++++++++++++++++++++ package.json | 14 +-- 6 files changed, 214 insertions(+), 19 deletions(-) rename .eslintrc.js => .eslintrc.cjs (100%) create mode 100644 jest.config.mjs diff --git a/.eslintrc.js b/.eslintrc.cjs similarity index 100% rename from .eslintrc.js rename to .eslintrc.cjs diff --git a/bin.js b/bin.js index 0516cef..4909085 100644 --- a/bin.js +++ b/bin.js @@ -1,7 +1,7 @@ #!/usr/bin/env node -const meow = require('meow') -const chalk = require('chalk') -const pkgOk = require('./') +import meow from 'meow' +import chalk from 'chalk' +import { pkgOk } from './index.js' const cli = meow(` Usage @@ -15,6 +15,7 @@ const cli = meow(` $ pkg-ok $ pkg-ok --field otherField --bin otherFile `, { + importMeta: import.meta, flags: { field: { alias: 'f', diff --git a/index.js b/index.js index ae7f82a..4a329e8 100644 --- a/index.js +++ b/index.js @@ -1,6 +1,6 @@ -const fs = require('fs') -const path = require('path') -const normalizeNewline = require('normalize-newline') +import fs from 'fs' +import path from 'path' +import normalizeNewline from 'normalize-newline' const FIELDS = [ 'bin', @@ -84,7 +84,7 @@ function normalizeScripts (pkg, dir, files) { } // Main function -function pkgOk (dir, { fields = [], bin = [] } = {}) { +export function pkgOk (dir, { fields = [], bin = [] } = {}) { const pkgPath = path.join(dir, 'package.json') const pkg = JSON.parse(fs.readFileSync(pkgPath)) @@ -104,5 +104,3 @@ function pkgOk (dir, { fields = [], bin = [] } = {}) { return [] } - -module.exports = pkgOk diff --git a/index.test.js b/index.test.js index 455bf35..9a5bcf1 100644 --- a/index.test.js +++ b/index.test.js @@ -1,7 +1,7 @@ -const fs = require('fs') -const path = require('path') -const mock = require('mock-fs') -const pkgOk = require('./') +import fs from 'fs' +import path from 'path' +import mock from 'mock-fs' +import { pkgOk } from './index.js' describe('pkg-ok', () => { beforeEach(() => { diff --git a/jest.config.mjs b/jest.config.mjs new file mode 100644 index 0000000..03351e5 --- /dev/null +++ b/jest.config.mjs @@ -0,0 +1,194 @@ +/* + * For a detailed explanation regarding each configuration property, visit: + * https://jestjs.io/docs/configuration + */ + +export default { + // 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/7g/91pdcw2929s400sdx4376k580000gp/T/jest_dy", + + // Automatically clear mock calls, instances and results before every test + clearMocks: true, + + // Indicates whether the coverage information should be collected while executing the test + // collectCoverage: false, + + // An array of glob patterns indicating a set of files for which coverage information should be collected + // collectCoverageFrom: undefined, + + // The directory where Jest should output its coverage files + // coverageDirectory: undefined, + + // 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: "v8", + + // A list of reporter names that Jest uses when writing coverage reports + // coverageReporters: [ + // "json", + // "text", + // "lcov", + // "clover" + // ], + + // An object that configures minimum threshold enforcement for coverage results + // coverageThreshold: undefined, + + // 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: undefined, + + // Run tests from one or more projects + // projects: undefined, + + // Use this configuration option to add custom reporters to Jest + // reporters: undefined, + + // Automatically reset mock state before every test + // resetMocks: false, + + // Reset the module registry before running each individual test + // resetModules: false, + + // A path to a custom resolver + // resolver: undefined, + + // Automatically restore mock state and implementation before every test + // restoreMocks: false, + + // 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: [ + // "" + // ], + + // 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", + + // 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: {}, + + // 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, +}; diff --git a/package.json b/package.json index 2b1097b..32dfa41 100644 --- a/package.json +++ b/package.json @@ -2,10 +2,12 @@ "name": "pkg-ok", "version": "2.3.1", "description": "Checks package.json main and bin paths", - "main": "index.js", + "exports": "./index.js", "bin": "bin.js", + "type": "module", "scripts": { - "test": "jest && eslint .", + "test": "npm run jest && eslint . && node ./bin", + "jest": "node --experimental-vm-modules node_modules/jest/bin/jest.js", "prepublishOnly": "npm test && node ./bin", "prepare": "husky install" }, @@ -44,12 +46,12 @@ "mock-fs": "^5.0.0" }, "dependencies": { - "chalk": "^4.0.0", - "meow": "^9.0.0", - "normalize-newline": "^3.0.0" + "chalk": "^5.0.0", + "meow": "^10.0.0", + "normalize-newline": "^4.0.0" }, "engines": { - "node": ">= 12" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" }, "husky": { "hooks": {