Skip to content

fix(package): specify side-effects in package.json #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(package): specify side-effects in package.json #383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions gulp/package-task.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import gulp from 'gulp';
import { memoizeTask } from './memoize-task.js';
import { EMPTY as ObservableEmpty, forkJoin as ObservableForkJoin } from 'rxjs';
import gulpJsonTransform from 'gulp-json-transform';
import { sync as globSync } from 'glob';
import path from 'node:path';

export const packageTask = ((cache) => memoizeTask(cache, function bundle(target, format) {
if (target === `src`) return ObservableEmpty();
Expand All @@ -20,6 +22,27 @@ export const packageTask = ((cache) => memoizeTask(cache, function bundle(target

export default packageTask;

function createSideEffectsList() {
const patterns = ['add/**/*.ts', 'asynciterable/todomstream.ts'];

const tsFilePaths = globSync(patterns.map((p) => `./src/${p}`));

// Generate .mjs and .js paths for each .ts file
const sideEffectPaths = [];
for (const filePath of tsFilePaths) {
// Get the relative path from srcDir to the file
const relativePath = path.relative('./src', filePath);
// Normalize path separators to forward slashes
const normalizedPath = relativePath.replace(/\\/g, '/');
// Remove the .ts extension and add .mjs and .js
const basePath = normalizedPath.replace(/\.ts$/, '');
sideEffectPaths.push(`./${basePath}.mjs`);
sideEffectPaths.push(`./${basePath}.js`);
}

return sideEffectPaths;
}

const createMainPackageJson = (target, format) => (orig) => ({
...createTypeScriptPackageJson(target, format)(orig),
bin: orig.bin,
Expand Down Expand Up @@ -48,7 +71,7 @@ const createMainPackageJson = (target, format) => (orig) => ({
},
'./*': createDualExport('*'),
},
sideEffects: false,
sideEffects: createSideEffectsList(),
esm: { mode: `all`, sourceMap: true }
});

Expand All @@ -60,7 +83,7 @@ const createTypeScriptPackageJson = (target, format) => (orig) => ({
types: `node.ts`,
browser: `dom.ts`,
type: 'module',
sideEffects: false,
sideEffects: createSideEffectsList(),
esm: { mode: `auto`, sourceMap: true },
dependencies: {
'@types/node': '*',
Expand Down Expand Up @@ -88,7 +111,7 @@ const createScopedPackageJSON = (target, format) => (({ name, ...orig }) =>
// set "module" if building scoped ESM target
module: format === 'esm' || format === 'cls' ? `node.js` : undefined,
// set "sideEffects" to false as a hint to Webpack that it's safe to tree-shake the ESM target
sideEffects: format === 'esm' || format === 'cls' ? false : undefined,
sideEffects: format === 'esm' || format === 'cls' ? createSideEffectsList() : undefined,
// include "esm" settings for https://www.npmjs.com/package/esm if building scoped ESM target
esm: format === `esm` ? { mode: `auto`, sourceMap: true } : undefined,
// set "types" to "dom" if building scoped UMD target, otherwise "node"
Expand Down