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

Cjs named import #196

Merged
merged 25 commits into from
Oct 1, 2021
Merged
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
2 changes: 2 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ const eslintConfig = composeEslintConfig(
__filename: "off",
__dirname: "off",
require: "off",
exports: "off",
},
overrides: [
{
Expand All @@ -82,6 +83,7 @@ const eslintConfig = composeEslintConfig(
__filename: true,
__dirname: true,
require: true,
exports: true,
},
// inside *.cjs files, use commonjs module resolution
settings: {
Expand Down
2 changes: 2 additions & 0 deletions experimental/commonjs_with_babel/convert_commonjs.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// eslint-disable-next-line no-undef
exports.answer = process.env.NODE_ENV

// eslint-disable-next-line no-undef
exports.setTimeout = global.setTimeout

// eslint-disable-next-line no-undef
Expand Down
2 changes: 1 addition & 1 deletion jsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@
"./node_modules/cssnano-preset-default/*"
],
"istanbul-lib-instrument": [
"./node_modules/istanbul-lib-instrument/dist/index.js"
"./node_modules/istanbul-lib-instrument/src/index.js"
],
"postcss/lib/declaration": [
"./node_modules/postcss/lib/declaration.js"
Expand Down
38 changes: 19 additions & 19 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jsenv/core",
"version": "21.0.3",
"version": "21.1.0",
"description": "Tool to develop, test and build js projects",
"license": "MIT",
"repository": {
Expand Down Expand Up @@ -57,7 +57,7 @@
"@babel/core": "7.15.5",
"@babel/helper-module-imports": "7.15.4",
"@babel/helpers": "7.15.4",
"@babel/parser": "7.15.6",
"@babel/parser": "7.15.7",
"@babel/plugin-proposal-dynamic-import": "7.14.5",
"@babel/plugin-proposal-json-strings": "7.14.5",
"@babel/plugin-proposal-numeric-separator": "7.14.5",
Expand Down Expand Up @@ -95,15 +95,15 @@
"@babel/plugin-transform-unicode-regex": "7.14.5",
"@c88/v8-coverage": "0.1.1",
"@jsenv/cancellation": "3.0.0",
"@jsenv/filesystem": "2.1.1",
"@jsenv/filesystem": "2.2.0",
"@jsenv/import-map": "6.13.3",
"@jsenv/logger": "4.0.1",
"@jsenv/node-signals": "2.0.1",
"@jsenv/server": "7.1.0",
"@jsenv/server": "7.2.0",
"@jsenv/uneval": "1.6.0",
"@rollup/plugin-commonjs": "20.0.0",
"@rollup/plugin-json": "4.1.0",
"@rollup/plugin-node-resolve": "13.0.4",
"@rollup/plugin-node-resolve": "13.0.5",
"@rollup/plugin-replace": "3.0.0",
"ansi-to-html": "0.7.1",
"babel-plugin-transform-async-to-promises": "0.8.15",
Expand All @@ -115,49 +115,49 @@
"html-minifier": "4.0.0",
"humanize-duration": "3.27.0",
"is-unicode-supported": "1.1.0",
"istanbul-lib-coverage": "3.0.0",
"istanbul-lib-instrument": "4.0.3",
"istanbul-lib-coverage": "3.0.1",
"istanbul-lib-instrument": "5.0.2",
"istanbul-lib-report": "3.0.0",
"istanbul-reports": "3.0.2",
"magic-string": "0.25.7",
"parse5": "6.0.1",
"playwright": "1.14.1",
"postcss": "8.3.6",
"playwright": "1.15.0",
"postcss": "8.3.8",
"postcss-value-parser": "4.1.0",
"regenerator-runtime": "0.13.9",
"rollup": "2.56.3",
"rollup": "2.57.0",
"rollup-plugin-node-builtins-brofs": "2.1.3",
"rollup-plugin-node-globals": "1.4.0",
"source-map": "0.7.3",
"string-width": "5.0.0",
"string-width": "5.0.1",
"supports-color": "9.0.2",
"systemjs": "6.10.3",
"terser": "5.7.2",
"terser": "5.9.0",
"tree-kill": "1.2.2",
"v8-to-istanbul": "8.0.0",
"wrap-ansi": "8.0.0"
"v8-to-istanbul": "8.1.0",
"wrap-ansi": "8.0.1"
},
"devDependencies": {
"@babel/eslint-parser": "7.15.4",
"@babel/eslint-parser": "7.15.7",
"@babel/plugin-transform-react-jsx": "7.14.9",
"@babel/plugin-transform-typescript": "7.15.4",
"@jsenv/assert": "2.3.1",
"@jsenv/codecov-upload": "3.5.0",
"@jsenv/eslint-config": "16.0.1",
"@jsenv/eslint-config": "16.0.4",
"@jsenv/github-release-package": "1.2.3",
"@jsenv/importmap-eslint-resolver": "5.1.2",
"@jsenv/importmap-node-module": "2.2.0",
"@jsenv/importmap-node-module": "2.2.1",
"@jsenv/node-module-import-map": "13.6.1",
"@jsenv/package-publish": "1.6.2",
"@jsenv/performance-impact": "1.7.0",
"@jsenv/prettier-check-project": "5.6.1",
"@jsenv/pwa": "4.0.0",
"eslint": "7.32.0",
"eslint-plugin-html": "6.1.2",
"eslint-plugin-html": "6.2.0",
"eslint-plugin-import": "2.24.2",
"node-notifier": "10.0.0",
"preact": "10.5.14",
"prettier": "2.4.0",
"prettier": "2.4.1",
"react": "17.0.2",
"redux": "4.1.1"
}
Expand Down
6 changes: 5 additions & 1 deletion src/commonJsToJavaScriptModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,11 @@ export const commonJsToJavaScriptModule = async ({
buffer: replaceBuffer,
})

const commonJsRollupPlugin = commonjs()
const commonJsRollupPlugin = commonjs({
// esmExternals: true,
// defaultIsModuleExports: true,
// requireReturnsDefault: "namespace",
})

const rollupBuild = await rollup({
input: filePath,
Expand Down
136 changes: 98 additions & 38 deletions src/internal/building/buildUsingRollup.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
import { createOperation } from "@jsenv/cancellation"
import { urlToFileSystemPath, ensureEmptyDirectory } from "@jsenv/filesystem"
import {
urlToFileSystemPath,
ensureEmptyDirectory,
readFile,
urlToRelativeUrl,
} from "@jsenv/filesystem"
import { createDetailedMessage } from "@jsenv/logger"

import { buildServiceWorker } from "@jsenv/core/src/internal/building/buildServiceWorker.js"
import { createJsenvRollupPlugin } from "./createJsenvRollupPlugin.js"
Expand Down Expand Up @@ -61,45 +67,50 @@ export const buildUsingRollup = async ({
runtimeSupport.safari,
)

const { jsenvRollupPlugin, getLastErrorMessage, getResult } =
await createJsenvRollupPlugin({
cancellationToken,
logger,
const {
jsenvRollupPlugin,
getLastErrorMessage,
getResult,
asOriginalUrl,
asProjectUrl,
} = await createJsenvRollupPlugin({
cancellationToken,
logger,

projectDirectoryUrl,
entryPointMap,
compileServerOrigin,
compileDirectoryRelativeUrl,
buildDirectoryUrl,
assetManifestFile,
assetManifestFileRelativeUrl,
writeOnFileSystem,
projectDirectoryUrl,
entryPointMap,
compileServerOrigin,
compileDirectoryRelativeUrl,
buildDirectoryUrl,
assetManifestFile,
assetManifestFileRelativeUrl,
writeOnFileSystem,

format,
systemJsUrl,
babelPluginMap,
transformTopLevelAwait,
node,
browser,

urlMappings,
importResolutionMethod,
importMapFileRelativeUrl,
importDefaultExtension,
externalImportSpecifiers,
externalImportUrlPatterns,
importPaths,

urlVersioning,
lineBreakNormalization,
jsConcatenation,
useImportMapToMaximizeCacheReuse,

minify,
minifyJsOptions,
minifyCssOptions,
minifyHtmlOptions,
})
format,
systemJsUrl,
babelPluginMap,
transformTopLevelAwait,
node,
browser,

urlMappings,
importResolutionMethod,
importMapFileRelativeUrl,
importDefaultExtension,
externalImportSpecifiers,
externalImportUrlPatterns,
importPaths,

urlVersioning,
lineBreakNormalization,
jsConcatenation,
useImportMapToMaximizeCacheReuse,

minify,
minifyJsOptions,
minifyCssOptions,
minifyHtmlOptions,
})

try {
await useRollup({
Expand All @@ -123,6 +134,25 @@ export const buildUsingRollup = async ({
}
throw e
}
if (e.code === "MISSING_EXPORT") {
let message = e.message
message = message.replace(e.id, (url) => asOriginalUrl(url))
message = message.replace(/(www|http:|https:)+[^\s]+[\w]/g, (url) =>
asOriginalUrl(url),
)
const importedFileRollupUrl = e.message.match(/not exported by (.*?),/)[1]
const convertSuggestion = await getConvertSuggestion({
importedFileRollupUrl,
asProjectUrl,
asOriginalUrl,
projectDirectoryUrl,
})
const detailedMessage = createDetailedMessage(message, {
frame: e.frame,
...convertSuggestion,
})
throw new Error(detailedMessage, { cause: e })
}
throw e
}

Expand Down Expand Up @@ -248,3 +278,33 @@ const formatToRollupFormat = (format) => {
if (format === "esmodule") return "esm"
throw new Error(`unexpected format, got ${format}`)
}

const getConvertSuggestion = async ({
importedFileRollupUrl,
asProjectUrl,
asOriginalUrl,
projectDirectoryUrl,
}) => {
const importedFileUrl = asProjectUrl(importedFileRollupUrl)
const importedFileContent = await readFile(importedFileUrl)
const looksLikeCommonJs =
importedFileContent.includes("module.exports = ") ||
importedFileContent.includes("exports.")

if (!looksLikeCommonJs) {
return null
}

const importerFileOriginalUrl = asOriginalUrl(importedFileUrl)
const importedFileOriginalRelativeUrl = urlToRelativeUrl(
importerFileOriginalUrl,
projectDirectoryUrl,
)
return {
suggestion: `The file seems written in commonjs, you should use "customCompiler" to convert it to js module
{
"./${importedFileOriginalRelativeUrl}": commonJsToJavaScriptModule
}
As documented in https://github.com/jsenv/jsenv-core/blob/master/docs/shared-parameters.md#customcompilers`,
}
}
6 changes: 6 additions & 0 deletions src/internal/building/createJsenvRollupPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ export const createJsenvRollupPlugin = async ({
let ressourceBuilder
let rollupEmitFile = () => {}
let rollupSetAssetSource = () => {}
let _rollupGetModuleInfo = () => {}
const rollupGetModuleInfo = (id) => _rollupGetModuleInfo(id)
let importResolver

const emitAsset = ({ fileName, source }) => {
Expand Down Expand Up @@ -228,6 +230,7 @@ building ${entryFileRelativeUrls.length} entry files...`)
// https://rollupjs.org/guide/en/#thisemitfileemittedfile-emittedchunk--emittedasset--string
rollupEmitFile = (...args) => this.emitFile(...args)
rollupSetAssetSource = (...args) => this.setAssetSource(...args)
_rollupGetModuleInfo = (id) => this.getModuleInfo(id)

let importMapInfoFromHtml = null
if (htmlEntryPointCount === 1) {
Expand Down Expand Up @@ -1176,6 +1179,9 @@ non-js ressources can be used with new URL("${urlRelativeToImporter}", import.me
buildStats,
}
},
asOriginalUrl,
asProjectUrl,
rollupGetModuleInfo,
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import { assert } from "@jsenv/assert"
import {
resolveDirectoryUrl,
urlToRelativeUrl,
urlToBasename,
} from "@jsenv/filesystem"
import { resolveDirectoryUrl, urlToRelativeUrl } from "@jsenv/filesystem"

import { buildProject } from "@jsenv/core"
import { jsenvCoreDirectoryUrl } from "@jsenv/core/src/internal/jsenvCoreDirectoryUrl.js"
Expand All @@ -18,13 +14,11 @@ const testDirectoryRelativeUrl = urlToRelativeUrl(
testDirectoryUrl,
jsenvCoreDirectoryUrl,
)
const testDirectoryname = urlToBasename(testDirectoryRelativeUrl)
const jsenvDirectoryRelativeUrl = `${testDirectoryRelativeUrl}.jsenv`
const buildDirectoryRelativeUrl = `${testDirectoryRelativeUrl}dist/commonjs`
const entryPointMap = {
[`./${testDirectoryRelativeUrl}${testDirectoryname}.js`]: "./main.cjs",
[`./${testDirectoryRelativeUrl}async_await.js`]: "./main.cjs",
}

await buildProject({
...GENERATE_COMMONJS_BUILD_TEST_PARAMS,
jsenvDirectoryRelativeUrl,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { basename } from "path"
import { assert } from "@jsenv/assert"
import { resolveUrl, urlToRelativeUrl } from "@jsenv/filesystem"

import { buildProject } from "@jsenv/core"
import { jsenvCoreDirectoryUrl } from "@jsenv/core/src/internal/jsenvCoreDirectoryUrl.js"
import { requireCommonJsBuild } from "@jsenv/core/test/requireCommonJsBuild.js"
Expand All @@ -14,27 +14,23 @@ const testDirectoryRelativeUrl = urlToRelativeUrl(
testDirectoryUrl,
jsenvCoreDirectoryUrl,
)
const testDirectoryname = basename(testDirectoryRelativeUrl)
const jsenvDirectoryRelativeUrl = `${testDirectoryRelativeUrl}.jsenv`
const buildDirectoryRelativeUrl = `${testDirectoryRelativeUrl}dist/commonjs`
const mainFilename = `${testDirectoryname}.js`
const entryPointMap = {
[`./${testDirectoryRelativeUrl}${mainFilename}`]: "./main.cjs",
[`./${testDirectoryRelativeUrl}async_await.js`]: "./main.cjs",
}

await buildProject({
...GENERATE_COMMONJS_BUILD_TEST_PARAMS,
babelPluginMap: {},
jsenvDirectoryRelativeUrl,
buildDirectoryRelativeUrl,
entryPointMap,
})
const {
namespace: { ask },
} = await requireCommonJsBuild({
const { namespace } = await requireCommonJsBuild({
...REQUIRE_COMMONJS_BUILD_TEST_PARAMS,
buildDirectoryRelativeUrl,
})
const actual = await ask()

const actual = await namespace.ask()
const expected = 42
assert({ actual, expected })
Loading