refactor: replace createRequire with import for package.json

godaddy · Jan 27, 2025 · d433e48 · d433e48
1 parent 040e466
commit d433e48
Show file tree

Hide file tree

Showing 24 changed files with 50 additions and 78 deletions.
diff --git a/packages/create-gasket-app/lib/index.js b/packages/create-gasket-app/lib/index.js
@@ -1,12 +1,10 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
-import { createRequire } from 'module';
+import pkg from '../package.json' with { type: 'json' };
 import { createCommand } from './commands/create.js';
 import { processCommand, logo } from './utils/index.js';
 import { warnIfOutdated } from '@gasket/utils';
 
-const require = createRequire(import.meta.url);
-const pkg = require('../package.json');
 const program = new Command();
 
 // Create Gasket CLI

diff --git a/packages/gasket-plugin-command/lib/cli.js b/packages/gasket-plugin-command/lib/cli.js
@@ -1,8 +1,7 @@
 import { Command } from 'commander';
 import { logo } from './utils/logo.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { version } = pkg;
 const program = new Command();
 
 // Create Gasket CLI

diff --git a/packages/gasket-plugin-command/lib/create.js b/packages/gasket-plugin-command/lib/create.js
@@ -1,8 +1,7 @@
 /// <reference types="create-gasket-app" />
 
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 /** @type {import('@gasket/core').HookHandler<'create'>} */
 export default function create(gasket, { pkg, gasketConfig }) {

diff --git a/packages/gasket-plugin-command/lib/index.js b/packages/gasket-plugin-command/lib/index.js
@@ -5,9 +5,8 @@ import configure from './configure.js';
 import prepare from './prepare.js';
 import commands from './commands.js';
 import ready from './ready.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 /** @type {import('@gasket/core').Plugin} */
 export default {

diff --git a/packages/gasket-plugin-command/test/cli.test.js b/packages/gasket-plugin-command/test/cli.test.js
@@ -1,9 +1,7 @@
-import { createRequire } from 'module';
 import { gasketBin } from '../lib/cli';
 import { processCommand } from '../lib/utils/process-command';
-
-const require = createRequire(import.meta.url);
-const { version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { version } = pkg;
 
 describe('cli', () => {
   it('should have a gasketBin property', () => {

diff --git a/packages/gasket-plugin-command/test/create.test.js b/packages/gasket-plugin-command/test/create.test.js
@@ -1,8 +1,7 @@
 import { jest } from '@jest/globals';
 import create from '../lib/create.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 describe('create', () => {
   let mockContext;

diff --git a/packages/gasket-plugin-command/test/index.test.js b/packages/gasket-plugin-command/test/index.test.js
@@ -1,8 +1,6 @@
 import plugin from '../lib/index.js';
-import { createRequire } from 'module';
-
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 describe('@gasket/plugin-command', () => {
   it('should export an object', () => {

diff --git a/packages/gasket-plugin-dynamic-plugins/lib/index.js b/packages/gasket-plugin-dynamic-plugins/lib/index.js
@@ -1,9 +1,8 @@
 /// <reference types="@gasket/plugin-metadata" />
 
 import prepare from './prepare.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 /** @type {import('@gasket/core').Plugin} */
 export default {

diff --git a/packages/gasket-plugin-https-proxy/lib/create.js b/packages/gasket-plugin-https-proxy/lib/create.js
@@ -1,6 +1,5 @@
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 /** @type {import('@gasket/core').HookHandler<'create'>} */
 export default function create(gasket, { pkg, gasketConfig }) {

diff --git a/packages/gasket-plugin-https-proxy/lib/index.js b/packages/gasket-plugin-https-proxy/lib/index.js
@@ -3,9 +3,8 @@
 
 import create from './create.js';
 import { actions } from './actions.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 /** @type {import('@gasket/core').Plugin} */
 export default {

diff --git a/packages/gasket-plugin-https-proxy/test/create.test.js b/packages/gasket-plugin-https-proxy/test/create.test.js
@@ -1,8 +1,7 @@
 import { vi, describe, it, expect, beforeEach } from 'vitest';
 import plugin from '../lib/index.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 describe('create', () => {
   let mockContext;

diff --git a/packages/gasket-plugin-https-proxy/test/index.test.js b/packages/gasket-plugin-https-proxy/test/index.test.js
@@ -1,8 +1,7 @@
 import { describe, it, expect, beforeEach } from 'vitest';
 import plugin from '../lib/index.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 describe('Plugin', function () {
   let gasket;

diff --git a/packages/gasket-plugin-metadata/lib/create.js b/packages/gasket-plugin-metadata/lib/create.js
@@ -1,6 +1,5 @@
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 /** @type {import('@gasket/core').HookHandler<'create'>} */
 export default function create(gasket, { pkg, gasketConfig }) {

diff --git a/packages/gasket-plugin-metadata/lib/index.js b/packages/gasket-plugin-metadata/lib/index.js
@@ -1,9 +1,9 @@
 import create from './create.js';
 import actions from './actions.js';
 import webpackConfig from './webpack-config.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+import corePkg from '@gasket/core/package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 /** @type {import('@gasket/core').Plugin} */
 export default ({
@@ -15,7 +15,6 @@ export default ({
     create,
     webpackConfig,
     metadata(gasket, meta) {
-      const mod = require('@gasket/core/package.json');
       return {
         ...meta,
         actions: [
@@ -34,9 +33,9 @@ export default ({
         }],
         modules: [
           {
-            name: mod.name,
-            version: mod.version,
-            description: mod.description,
+            name: corePkg.name,
+            version: corePkg.version,
+            description: corePkg.description,
             link: 'README.md'
           }
         ]

diff --git a/packages/gasket-plugin-metadata/lib/webpack-config.js b/packages/gasket-plugin-metadata/lib/webpack-config.js
@@ -1,9 +1,7 @@
 /// <reference types="@gasket/plugin-webpack" />
 
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-
-const { name } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name } = pkg;
 
 /** @type {import('@gasket/core').HookHandler<'webpackConfig'>} */
 export default function webpackConfigHook(gasket, webpackConfig) {

diff --git a/packages/gasket-plugin-metadata/test/create.test.js b/packages/gasket-plugin-metadata/test/create.test.js
@@ -1,8 +1,7 @@
 import { vi } from 'vitest';
 import plugin from '../lib/index.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version } = require('../package');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version } = pkg;
 
 describe('create', () => {
   let mockContext;

diff --git a/packages/gasket-plugin-metadata/test/index.test.js b/packages/gasket-plugin-metadata/test/index.test.js
@@ -1,8 +1,7 @@
 /* eslint-disable max-statements */
 import plugin from '../lib/index.js';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 describe('Plugin', function () {
   let gasket;

diff --git a/packages/gasket-plugin-metadata/test/webpack-config.test.js b/packages/gasket-plugin-metadata/test/webpack-config.test.js
@@ -1,7 +1,6 @@
 import webpackConfigHook from '../lib/webpack-config';
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-const { name } = require('../package');
+import pkg from '../package.json' with { type: 'json' };
+const { name } = pkg;
 
 describe('webpackConfig', function () {
   let mockGasket, mockWebpackConfig;

diff --git a/packages/gasket-plugin-nextjs/generator/jest/page-router/test/index.spec.js b/packages/gasket-plugin-nextjs/generator/jest/page-router/test/index.spec.js
@@ -4,8 +4,7 @@ import IndexPage from '../pages/index.js';
 import { expect } from '@jest/globals';
 {{#if hasGasketIntl}}
 import { IntlProvider } from 'react-intl';
-import { createRequire } from 'module';
-const messages = createRequire(import.meta.url)('../locales/en-US.json');
+import messages from '../locales/en-US.json' with { type: 'json' };
 {{/if}}
 
 describe('IndexPage', () => {

diff --git a/packages/gasket-preset-api/lib/create.js b/packages/gasket-preset-api/lib/create.js
@@ -1,8 +1,7 @@
 import path from 'path';
-import { createRequire } from 'module';
 import { fileURLToPath } from 'url';
-const require = createRequire(import.meta.url);
-const { devDependencies } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { devDependencies } = pkg;
 
 /** @type {import('@gasket/core').HookHandler<'create'>} */
 export default function create(gasket, context) {

diff --git a/packages/gasket-preset-api/lib/index.js b/packages/gasket-preset-api/lib/index.js
@@ -1,9 +1,8 @@
-import { createRequire } from 'module';
 import presetPrompt from './preset-prompt.js';
 import presetConfig from './preset-config.js';
 import create from './create.js';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 /** @type {import('@gasket/core').Preset} */
 export default {

diff --git a/packages/gasket-preset-api/test/create.test.js b/packages/gasket-preset-api/test/create.test.js
@@ -1,8 +1,7 @@
 import { jest } from '@jest/globals';
-import { createRequire } from 'module';
 import preset from '../lib/index.js';
-const require = createRequire(import.meta.url);
-const { devDependencies } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { devDependencies } = pkg;
 const mockPkgAdd = jest.fn();
 const mockFilesAdd = jest.fn();
 

diff --git a/packages/gasket-preset-api/test/index.test.js b/packages/gasket-preset-api/test/index.test.js
@@ -1,12 +1,11 @@
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
 import preset from '../lib/index.js';
+import pkg from '../package.json' with { type: 'json' };
 const {
   name,
   version,
   description,
   dependencies
-} = require('../package.json');
+} = pkg;
 
 describe('gasket-preset-api', () => {
 

diff --git a/packages/gasket-preset-nextjs/lib/index.js b/packages/gasket-preset-nextjs/lib/index.js
@@ -1,9 +1,8 @@
-import { createRequire } from 'module';
 import presetPrompt from './preset-prompt.js';
 import presetConfig from './preset-config.js';
 import create from './create.js';
-const require = createRequire(import.meta.url);
-const { name, version, description } = require('../package.json');
+import pkg from '../package.json' with { type: 'json' };
+const { name, version, description } = pkg;
 
 /** @type {import('@gasket/core').Preset} */
 export default {