From 85a80d87944b29b769ab5d58f4e9d8581bbb51e3 Mon Sep 17 00:00:00 2001 From: Bertrand Guay-Paquet Date: Fri, 29 Jul 2022 21:59:09 +0200 Subject: [PATCH] Port doc changes from #4572 and #4583 to 3.0 --- docs/01-command-line-reference.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/docs/01-command-line-reference.md b/docs/01-command-line-reference.md index 62b4f630b3a..97796196840 100755 --- a/docs/01-command-line-reference.md +++ b/docs/01-command-line-reference.md @@ -303,30 +303,19 @@ It can be useful to import your package file to e.g. mark your dependencies as " import pkg from './package.json' assert { type: 'json' }; export default { - input: 'src/main.js', - external: Object.keys(pkg.dependencies), - output: { - format: 'es', - dir: 'dist' - } + // Mark package dependencies as "external". Rest of configuration omitted. + external: Object.keys(pkg.dependencies) }; ``` -- For older Node versions, you can use "createRequire" +- For older Node versions, you can use `createRequire` ```js import { createRequire } from 'module'; const require = createRequire(import.meta.url); const pkg = require('./package.json'); - export default { - input: 'src/main.js', - external: Object.keys(pkg.dependencies), - output: { - format: 'es', - dir: 'dist' - } - }; + // ... ``` - Or just directly read and parse the file from disk @@ -334,10 +323,11 @@ It can be useful to import your package file to e.g. mark your dependencies as " ```js // rollup.config.mjs import { readFileSync } from 'fs'; - import { fileURLToPath } from 'url'; - const pkgFileName = fileURLToPath(new URL('./package.json', import.meta.url)); - const pkg = JSON.parse(readFileSync(pkgFileName)); + // Use import.meta.url to make the path relative to the current source file instead of process.cwd() + // For more info: https://nodejs.org/docs/latest-v16.x/api/esm.html#importmetaurl + const packageJson = JSON.parse(readFileSync(new URL('./package.json', import.meta.url))); + // ... ```