Skip to content
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.

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

build!: migrate to type: "module" (WIP) #137

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
node_modules
/lib/typings
.eslintrc.js
.eslintrc.cjs
/example
/test/.build
/test/CMakeFiles
Expand All @@ -13,4 +14,4 @@ node_modules
/packages/**/test/**/actual
/packages/**/test/**/expected
/packages/**/test/**/rollup/src
/out
out
4 changes: 2 additions & 2 deletions .eslintrc.js → .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const sharedRules = {
'no-new-func': 'off',
'no-implied-eval': 'off',
'no-var': 'off',
'camelcase': 'off'
camelcase: 'off'
}

module.exports = {
Expand Down Expand Up @@ -72,7 +72,7 @@ module.exports = {
project: './tsconfig.json',
tsconfigRootDir: __dirname,
createDefaultProgram: true
},
}
}
]
}
4 changes: 4 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,9 @@
"launch": {
"statusBarVisibility": "hidden"
}
},
"livePreview.httpHeaders": {
"Cross-Origin-Embedder-Policy": "require-corp",
"Cross-Origin-Opener-Policy": "same-origin"
}
}
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"prepare": "npm run build",
"build": "npm run build --workspaces --if-present",
Expand Down Expand Up @@ -53,6 +54,7 @@
"typescript": "~5.7.2"
},
"workspaces": [
"packages/shared",
"packages/ts-transform-macro",
"packages/ts-transform-emscripten-esm-library",
"packages/ts-transform-emscripten-parse-tools",
Expand Down
24 changes: 24 additions & 0 deletions packages/shared/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "@emnapi/shared",
"version": "1.3.1",
"private": true,
"description": "",
"type": "module",
"scripts": {
"build": "tsc -p ./tsconfig.json"
},
"main": "./out/index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/toyobayashi/emnapi.git"
},
"author": "toyobayashi",
"license": "MIT",
"bugs": {
"url": "https://github.com/toyobayashi/emnapi/issues"
},
"homepage": "https://github.com/toyobayashi/emnapi/tree/main/packages/shared",
"publishConfig": {
"access": "public"
}
}
91 changes: 91 additions & 0 deletions packages/shared/src/build.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
#!/usr/bin/env node

import path from 'path'
import fs from 'fs'
import ts from 'typescript'
import type { RollupOptions, RollupBuild, OutputOptions } from 'rollup'
import { loadConfigFile } from 'rollup/loadConfigFile'
import { pathToFileURL } from 'url'

export async function build (workspace: string): Promise<void> {
const { compile } = await import('@tybys/tsapi')
const { rollup } = await import('rollup')

compile(path.resolve(workspace, 'tsconfig.json'), {
optionsToExtend: {
target: ts.ScriptTarget.ES2021,
outDir: path.resolve(workspace, 'lib'),
emitDeclarationOnly: true,
declaration: true,
declarationMap: true,
declarationDir: path.resolve(workspace, 'lib/typings')
}
})

const {
Extractor,
ExtractorConfig
} = await import('@microsoft/api-extractor')
const apiExtractorJsonPath = path.resolve(workspace, 'api-extractor.json')
const extractorConfig = ExtractorConfig.loadFileAndPrepare(apiExtractorJsonPath)
const extractorResult = Extractor.invoke(extractorConfig, {
localBuild: true,
showVerboseMessages: true
})
if (extractorResult.succeeded) {
console.log('API Extractor completed successfully')
} else {
const errmsg = `API Extractor completed with ${extractorResult.errorCount} errors and ${extractorResult.warningCount} warnings`
throw new Error(errmsg)
}

const dts = extractorConfig.publicTrimmedFilePath

const { options } = await loadConfigFile(path.resolve(workspace, 'rollup.config.js'), {})

const runRollup = async (conf: RollupOptions): Promise<void> => {
const bundle = await rollup(conf)

const writeBundle = async (bundle: RollupBuild, output: OutputOptions): Promise<void> => {
const writeOutput = await bundle.write(output ?? {})

for (const file of writeOutput.output) {
if (file.type === 'asset') {
console.log(`[Asset] ${output.file ?? file.fileName}`)
} else if (file.type === 'chunk') {
console.log(`[Chunk] ${output.file ?? file.fileName}`)
}
}

if (output?.file) {
if (output.file.endsWith('.umd.cjs')) {
const umdDts = output.file.replace(/\.cjs$/, '.d.cts')
fs.copyFileSync(dts, umdDts)
if (output.name) {
fs.appendFileSync(umdDts, `\nexport as namespace ${output.name};\n`, 'utf8')
}
} else if (output.file.endsWith('.umd.min.cjs')) {
// ignore
} else if (output.file.endsWith('.cjs')) {
const cjsDts = output.file.replace(/\.cjs$/, '.d.cts')
fs.copyFileSync(dts, cjsDts)
}
}
}

if (Array.isArray(conf.output)) {
await Promise.all(conf.output.map(o => writeBundle(bundle, o ?? {})))
} else {
await writeBundle(bundle, conf.output ?? {})
}
}

await Promise.all(options.map(runRollup))
}

if (import.meta.url === pathToFileURL(process.argv[1]).href) {
build(process.argv[2] ?? process.cwd()).catch(err => {
console.error(err)
process.exit(1)
})
}
2 changes: 2 additions & 0 deletions packages/shared/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from './rollup.ts'
export * from './build.ts'
146 changes: 146 additions & 0 deletions packages/shared/src/rollup.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
import type { InputPluginOption, InputOptions, RollupOptions, NullValue, ExternalOption } from 'rollup'
import ts from 'typescript'

import { createRequire } from 'module'
const require = createRequire(import.meta.url)

const rollupTypescript = require('@rollup/plugin-typescript').default as typeof import('@rollup/plugin-typescript').default
const rollupNodeResolve = require('@rollup/plugin-node-resolve').default as typeof import('@rollup/plugin-node-resolve').default
const rollupReplace = require('@rollup/plugin-replace').default as typeof import('@rollup/plugin-replace').default
const transformPureClass = require('@tybys/ts-transform-pure-class').default as typeof import('@tybys/ts-transform-pure-class').default
const rollupTerser = require('@rollup/plugin-terser').default

export type Format = 'esm' | 'cjs' | 'umd' | 'esm-browser'

export interface Options extends Omit<InputOptions, 'external'> {
outputName: string
outputFile: string
compilerOptions?: ts.CompilerOptions
defines?: Record<string, any>
external?: ExternalOption | ((source: string, importer: string | undefined, isResolved: boolean, format: Format) => boolean | NullValue)
}

interface CreateConfigOptions extends Options {
format: Format
minify?: boolean
}

function createConfig (options: CreateConfigOptions): RollupOptions {
const {
input,
outputName,
outputFile,
compilerOptions,
plugins,
minify,
format,
defines,
external,
...restInput
} = options ?? {}
const target = compilerOptions?.target ?? ts.ScriptTarget.ES2021

const defaultPlugins: InputPluginOption[] = [
rollupTypescript({
compilerOptions: {
...(target !== ts.ScriptTarget.ES5 ? { removeComments: true, downlevelIteration: false } : {}),
...options?.compilerOptions
},
transformers: {
after: [
transformPureClass
]
}
}),
rollupNodeResolve({
mainFields: ['module', 'module-sync', 'import', 'main']
}),
rollupReplace({
preventAssignment: true,
values: {
__FORMAT__: JSON.stringify(format),
__DEV__: format === 'umd' || format === 'esm-browser' ? (minify ? 'false' : 'true') : '(process.env.NODE_ENV !== "production")',
...(format === 'umd' || format === 'esm-browser' ? { 'process.env.NODE_ENV': minify ? '"production"' : '"development"' } : {}),
...defines
}
}),
...(minify
? [
rollupTerser.default({
compress: true,
mangle: true,
format: {
comments: false
}
})
]
: [])
]

const outputDir = 'dist'
const outputs = {
esm: {
file: `${outputDir}/${outputFile}${minify ? '.min' : ''}.js`,
format: 'esm',
exports: 'named'
} satisfies RollupOptions['output'],
'esm-browser': {
file: `${outputDir}/${outputFile}.browser${minify ? '.min' : ''}.js`,
format: 'esm',
exports: 'named'
} satisfies RollupOptions['output'],
cjs: {
file: `${outputDir}/${outputFile}${minify ? '.min' : ''}.cjs`,
format: 'cjs',
exports: 'named'
} satisfies RollupOptions['output'],
umd: {
file: `${outputDir}/${outputFile}.umd${minify ? '.min' : ''}.cjs`,
format: 'umd',
name: outputName,
exports: 'named'
} satisfies RollupOptions['output']
}

const defaultExternals: Record<CreateConfigOptions['format'], string[]> = {
esm: ['tslib'],
'esm-browser': [],
cjs: ['tslib'],
umd: []
}

return {
input: input ?? 'src/index.ts',
external: typeof external === 'function'
? function (this: any, id: string, parent, isResolved) {
const result = external.call(this, id, parent, isResolved, format)
if (result) return result
return defaultExternals[format]?.includes(id)
}
: Array.isArray(external)
? [...new Set([...(defaultExternals[format] ?? []), ...external])]
: defaultExternals[format],
plugins: plugins instanceof Promise
? plugins.then(p => {
return [...defaultPlugins, ...(Array.isArray(p) ? p : [p])]
})
: [...defaultPlugins, ...(Array.isArray(plugins) ? plugins : [plugins])],
...restInput,
output: outputs[format]
}
}

export function defineConfig (options: Options): RollupOptions[] {
return ([
['esm', false],
['cjs', false],
['umd', false],
['umd', true],
['esm-browser', false],
['esm-browser', true]
] as const).map(([format, minify]) => createConfig({
...options,
format,
minify
}))
}
17 changes: 17 additions & 0 deletions packages/shared/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"extends": "./tsconfig.base.json",
"compilerOptions": {
"target": "ES2021",
"module": "NodeNext",
"moduleResolution": "nodenext",
"strict": true,
"declaration": true,
"sourceMap": true,
"declarationMap": true,
"outDir": "out",
"rewriteRelativeImportExtensions": true
},
"include": [
"src/**/*.ts"
]
}
1 change: 1 addition & 0 deletions packages/test/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"node-addon-api": "8.1.0",
"why-is-node-running": "^2.3.0"
},
"type": "commonjs",
"scripts": {
"rebuild": "cross-env UV_THREADPOOL_SIZE=2 node ./script/build-emscripten.js Debug",
"rebuild:r": "cross-env UV_THREADPOOL_SIZE=2 node ./script/build-emscripten.js Release",
Expand Down
28 changes: 12 additions & 16 deletions packages/wasi-threads/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,31 @@
"name": "@emnapi/wasi-threads",
"version": "1.0.1",
"description": "WASI threads proposal implementation in JavaScript",
"main": "index.js",
"module": "./dist/wasi-threads.esm-bundler.js",
"type": "module",
"main": "./dist/wasi-threads.cjs",
"module": "./dist/wasi-threads.js",
"types": "./dist/wasi-threads.d.ts",
"sideEffects": false,
"exports": {
".": {
"types": {
"module": "./dist/wasi-threads.d.ts",
"import": "./dist/wasi-threads.d.mts",
"default": "./dist/wasi-threads.d.ts"
"module-sync": "./dist/wasi-threads.d.ts",
"import": "./dist/wasi-threads.d.cts",
"require": "./dist/wasi-threads.d.cts",
"default": "./dist/wasi-threads.d.cts"
},
"module": "./dist/wasi-threads.esm-bundler.js",
"import": "./dist/wasi-threads.mjs",
"default": "./index.js"
"module": "./dist/wasi-threads.js",
"module-sync": "./dist/wasi-threads.js",
"default": "./dist/wasi-threads.cjs"
},
"./dist/wasi-threads.cjs.min": {
"types": "./dist/wasi-threads.d.ts",
"default": "./dist/wasi-threads.cjs.min.js"
},
"./dist/wasi-threads.min.mjs": {
"types": "./dist/wasi-threads.d.mts",
"default": "./dist/wasi-threads.min.mjs"
}
"./package.json": "./package.json"
},
"dependencies": {
"tslib": "^2.4.0"
},
"scripts": {
"build": "node ./script/build.js",
"build": "node ../shared/out/build.js .",
"build:test": "node ./test/build.js",
"test": "node ./test/index.js"
},
Expand Down
Loading