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

chore(gatsby-cli): bundle ink logger #26887

Merged
merged 5 commits into from
Sep 15, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 0 additions & 3 deletions packages/gatsby-cli/.babelrc

This file was deleted.

20 changes: 20 additions & 0 deletions packages/gatsby-cli/.babelrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"presets": [
[
"@babel/env",
{
"modules": false,
"shippedProposals": true,
"targets": { "node": "10.13.0" }
}
],
"@babel/preset-react"
],
"plugins": ["@babel/plugin-transform-runtime"],
"overrides": [
{
"test": ["**/*.ts", "**/*.tsx"],
"plugins": [["@babel/plugin-transform-typescript", { "isTSX": true }]]
}
]
}
7 changes: 7 additions & 0 deletions packages/gatsby-cli/non-rollup-babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// This being a babel.config.js file instead of a .babelrc file allows the
// packages in `internal-plugins` to be compiled with the rest of the source.
// Ref: https://github.com/babel/babel/pull/7358

const configPath = require(`path`).join(__dirname, `..`, `..`, `.babelrc.js`)

module.exports = require(configPath)
24 changes: 19 additions & 5 deletions packages/gatsby-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
"gatsby-recipes": "^0.2.24",
"gatsby-telemetry": "^1.3.32",
"hosted-git-info": "^3.0.4",
"ink": "^2.7.1",
"ink-spinner": "^3.1.0",
"is-valid-path": "^0.1.1",
"lodash": "^4.17.20",
"meant": "^1.0.1",
Expand All @@ -37,7 +35,6 @@
"pretty-error": "^2.1.1",
"progress": "^2.0.3",
"prompts": "^2.3.2",
"react": "^16.8.0",
"redux": "^4.0.5",
"resolve-cwd": "^3.0.0",
"semver": "^7.3.2",
Expand All @@ -48,16 +45,29 @@
"update-notifier": "^4.1.0",
"uuid": "3.4.0",
"yargs": "^15.3.1",
"yoga-layout-prebuilt": "^1.9.6",
"yurnalist": "^1.1.2"
},
"devDependencies": {
"@babel/cli": "^7.10.3",
"@babel/core": "^7.10.3",
"@rollup/plugin-babel": "^5.1.0",
"@rollup/plugin-commonjs": "^14.0.0",
"@rollup/plugin-json": "^4.1.0",
"@rollup/plugin-node-resolve": "^8.4.0",
"@rollup/plugin-replace": "^2.3.3",
"@types/hosted-git-info": "^3.0.0",
"@types/yargs": "^15.0.4",
"babel-preset-gatsby-package": "^0.5.2",
"concurrently": "^5.0.0",
"cross-env": "^5.2.1",
"rimraf": "^3.0.2",
"ink": "^2.7.1",
"ink-spinner": "^3.1.0",
"react": "^16.8.0",
"rollup": "^2.23.0",
"rollup-plugin-auto-external": "^2.0.0",
"rollup-plugin-internal": "^1.0.0",
"typescript": "^3.9.5"
},
"files": [
Expand All @@ -77,10 +87,14 @@
"directory": "packages/gatsby-cli"
},
"scripts": {
"build": "babel src --out-dir lib --ignore \"**/__tests__\" --extensions \".ts,.js,.tsx\"",
"build:babel": "babel --config-file ./non-rollup-babel.config.js src --out-dir lib --ignore \"**/__tests__\" --ignore \"src/reporter/loggers/ink/**/*\" --extensions \".ts,.js,.tsx\"",
"build:rollup": "rollup -c",
"build": "concurrently \"npm run build:babel\" \"npm run build:rollup\"",
"prepare": "cross-env NODE_ENV=production npm run build && npm run typegen",
"typegen": "rimraf \"lib/**/*.d.ts\" && tsc --emitDeclarationOnly --declaration --declarationDir lib/",
"watch": "babel -w src --out-dir lib --ignore \"**/__tests__\" --extensions \".ts,.js,.tsx\"",
"watch:babel": "npm run build:babel -- --watch",
"watch:rollup": "npm run build:rollup -- -w",
"watch": "concurrently \"npm run watch:babel\" \"npm run watch:rollup\"",
"postinstall": "node scripts/postinstall.js"
},
"engines": {
Expand Down
69 changes: 69 additions & 0 deletions packages/gatsby-cli/rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import resolve from "@rollup/plugin-node-resolve"
import babel from "@rollup/plugin-babel"
import commonjs from "@rollup/plugin-commonjs"
import json from "@rollup/plugin-json"
import replace from "@rollup/plugin-replace";
import autoExternal from "rollup-plugin-auto-external"
import internal from "rollup-plugin-internal"

import path from "path"

// Rollup hoists Ink's dynamic require of react-devtools-core which causes
// a window not found error so we exclude Ink's devtools file for now.
function excludeDevTools() {
const re = /ink/
return {
name: `ignoreDevTools`,

load(id) {
if (id.match(re)) {
if (path.parse(id).name === `devtools`) {
return { code: `` }
}
}
},
}
}

export default {
input: `src/reporter/loggers/ink/index.tsx`,
output: {
file: `lib/reporter/loggers/ink/index.js`,
format: `cjs`,
},
cache: false,
plugins: [
replace({
values: {
"process.env.NODE_ENV": JSON.stringify(`production`)
}
}),
excludeDevTools(),
json(),
babel({
extensions: [`.js`, `.jsx`, `.es6`, `.es`, `.mjs`, `.ts`, `.tsx`] ,
babelHelpers: `runtime`,
skipPreflightCheck: true,
exclude: `node_modules/**`,
}),
resolve({
extensions: [`.mjs`, `.js`, `.json`, `.node`, `.ts`, `.tsx`],
dedupe: [ `react`, `ink` ]
}),
commonjs(),
autoExternal(),
internal([
`react`,
`ink`,
`ink-spinner`
]),
],
external: [
`yoga-layout-prebuilt`,
// Next one deserve explanation: ... it's because ink logger imports
// getStore, onLogAction from higher up (../../redux). But we don't want
// two copies of it - one bundled and one not, because it would result
// in multiple store copies
`../../redux`
Comment on lines +63 to +67
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding inline comment here to highlight this - this is the most fragile part of this setup

]
}
10 changes: 9 additions & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3094,6 +3094,14 @@
is-module "^1.0.0"
resolve "^1.17.0"

"@rollup/plugin-replace@^2.3.3":
version "2.3.3"
resolved "https://registry.yarnpkg.com/@rollup/plugin-replace/-/plugin-replace-2.3.3.tgz#cd6bae39444de119f5d905322b91ebd4078562e7"
integrity sha512-XPmVXZ7IlaoWaJLkSCDaa0Y6uVo5XQYHhiMFzOd5qSv5rE+t/UJToPIOE56flKIxBFQI27ONsxb7dqHnwSsjKQ==
dependencies:
"@rollup/pluginutils" "^3.0.8"
magic-string "^0.25.5"

"@rollup/pluginutils@^3.0.0", "@rollup/pluginutils@^3.0.8", "@rollup/pluginutils@^3.1.0":
version "3.1.0"
resolved "https://registry.yarnpkg.com/@rollup/pluginutils/-/pluginutils-3.1.0.tgz#706b4524ee6dc8b103b3c995533e5ad680c02b9b"
Expand Down Expand Up @@ -15684,7 +15692,7 @@ magic-string@^0.22.4:
dependencies:
vlq "^0.2.2"

magic-string@^0.25.2, magic-string@^0.25.3:
magic-string@^0.25.2, magic-string@^0.25.3, magic-string@^0.25.5:
version "0.25.7"
resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.25.7.tgz#3f497d6fd34c669c6798dcb821f2ef31f5445051"
integrity sha512-4CrMT5DOHTDk4HYDlzmwu4FVCcIYI8gauveasrdCu2IKIFOJ3f0v/8MDGJCDL9oD2ppz/Av1b0Nj345H9M+XIA==
Expand Down