feat: improve programatic usage by pi0 · Pull Request #6868 · nuxt/nuxt

pi0 · 2020-01-14T15:20:05Z

Types of changes

Bug fix (a non-breaking change which fixes an issue)
New feature (a non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Description

UPDATE: See docs

Refactor config loading logic into @nuxt/config package and abstract from CLI arguments
Expose loadNuxtConfig, loadNuxt, getBuilder, build and getGenerator

Goal: Making programmatic usage better for making custom solutions without the need to worry about loading config, handling breaking changes for class constructors. Also making @nuxt/cli more lightweight only focusing on its own functionality.

Example:

import { loadNuxt } from 'nuxt'

// Load nuxt instances with config loaded from the current directory
const nuxt  = await loadNuxt({ for: 'dev' })

// Specify rootDir (and/or configFile)
const nuxt = await loadNuxt({ rootDir, for: 'start' })

New programmatic usage for using as a middleware: See Example

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly. (PR: feat: loadNuxt and build docs#1811)
I have added tests to cover my changes (if not applicable, please state why)
All new and existing tests are passing.

pi0 · 2020-01-14T15:28:43Z

(some GH steps failing because of cache issues)

codecov-io · 2020-01-14T15:33:03Z

Codecov Report

Merging #6868 into dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #6868   +/-   ##
=======================================
  Coverage   64.46%   64.46%           
=======================================
  Files          82       82           
  Lines        2744     2744           
  Branches      714      714           
=======================================
  Hits         1769     1769           
  Misses        741      741           
  Partials      234      234

Flag	Coverage Δ
#unit	`64.46% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dbfa857...98f3b0d. Read the comment docs.

kevinmarrec · 2020-01-14T15:47:34Z

@pi0 What's wrong with node-sass audit ? Doesn't sound related to cache

EDIT: Unless it takes into account vulnerability in some bugged node_modules cache
EDIT2: https://www.npmjs.com/advisories/961 Sounds like the advisory has been published yesterday

clarkdo

@pi0 @kevinmarrec The github action failure is because of a new found DoS vulnerability in all versions of node-sass which doesn't have a patch yet.
https://www.npmjs.com/advisories/961

clarkdo · 2020-01-14T16:50:23Z

packages/core/src/index.js

@@ -1,3 +1,12 @@
+import { loadNuxtConfig } from '@nuxt/config'
+import Nuxt from './nuxt'


We have export { default as Nuxt } from './nuxt' below, now it can be :

export Nuxt

Same for export { loadNuxtConfig } from '@nuxt/config'

I was thinking this way ensure less breaking changes and the fact that we don't export something else by accident. Also fewer characters :)

packages/generator/src/index.js

packages/builder/src/index.js

examples/programmatic/scripts/dev.js

examples/programmatic/scripts/start.js

clarkdo · 2020-01-15T21:12:01Z

packages/builder/src/index.js

@@ -1 +1,10 @@
+import Builder from './builder'


Can be export default Builder ?

The way of exporting classes can be improved in another PR :)

packages/cli/src/utils/config.js

clarkdo · 2020-01-17T19:52:58Z

Is this a breaking change?

If not, we’ll have 2 different programmatic ways, are we planning to remove old way in next release?

pi0 · 2020-01-17T23:26:45Z

@clarkdo No, this PR doesn't break the current type of usage but adding new recommended method of getting nuxt instance.

crutch12 · 2020-09-30T12:50:53Z

Hi, @pi0
Suddenly found out that publicRuntimeConfig/privateRuntimeConfig doesn't work with legacy programatic usage:

server.js

const { Nuxt, Builder } = require('nuxt');
const nuxt = new Nuxt(config);
await nuxt.ready();

nuxt.config.js

export default {
    publicRuntimeConfig: ($env) => {
      return {
        NODE_ENV: $env.NODE_ENV,
        wtf: 'WTF',
      };
    },
}

The resulting script

<script>window.__NUXT__={config:{},staticAssetsBase:void 0}</script>

instead of

<script>window.__NUXT__={config:{NODE_ENV:"development",wtf:"WTF"},staticAssetsBase:void 0}</script>

It would be great to deprecate legacy syntax or add support for runtimeConfig

pi0 added 4 commits January 14, 2020 15:54

refactor: move loadNuxtConfig to @nuxt/config

a4de7bd

feat(core): expose getNuxt utility

b8ec9ad

feat: expose getGenerator and getBuilder

485fe0f

feat: expose loadNuxtConfig from core

9228187

pi0 force-pushed the feat/get-nuxt branch from 56199cf to 9228187 Compare January 14, 2020 15:26

pi0 requested review from a team and atinux January 14, 2020 15:31

kevinmarrec previously approved these changes Jan 14, 2020

View reviewed changes

clarkdo previously approved these changes Jan 14, 2020

View reviewed changes

clarkdo reviewed Jan 14, 2020

View reviewed changes

packages/generator/src/index.js Show resolved Hide resolved

clarkdo reviewed Jan 14, 2020

View reviewed changes

packages/builder/src/index.js Show resolved Hide resolved

fix: await on loadNuxtConfig promise

fd780ce

pi0 dismissed stale reviews from clarkdo and kevinmarrec via fd780ce January 14, 2020 22:01

pi0 added 3 commits January 14, 2020 23:17

Merge branch 'dev' into feat/get-nuxt

e442833

allow dev option + auto _start

5b43596

expose build helper

a3cddf3

atinux mentioned this pull request Jan 14, 2020

feat: loadNuxt and build nuxt/docs#1811

Merged

pi0 added 4 commits January 15, 2020 12:24

improve loadNuxt

549cc88

minor fixes

a475a85

add programmatic example

657c416

because i still confuse between meta and head

b648872

pi0 changed the title ~~feat: expose getNuxt and loadNuxtConfig utilities~~ feat: improve programatic usage Jan 15, 2020

Merge branch 'dev' into feat/get-nuxt

0477786

clarkdo reviewed Jan 15, 2020

View reviewed changes

Merge branch 'dev' into feat/get-nuxt

dbfa857

Merge branch 'dev' into feat/get-nuxt

98f3b0d

atinux approved these changes Jan 17, 2020

View reviewed changes

pi0 merged commit 2707bdb into dev Jan 19, 2020

pi0 deleted the feat/get-nuxt branch January 19, 2020 08:36

This was referenced Feb 25, 2020

v2.12.0 #6999

Merged

feat: expose webpack config #7029

Merged

This was referenced Mar 20, 2020

Upgrade nuxt from 2.11.0 to 2.12.0 OpenLightingProject/open-fixture-library#1238

Merged

[Snyk] Upgrade nuxt from 2.11.0 to 2.12.0 ovlb/root.ovl.design#10

Open

This was referenced Mar 28, 2020

Upgrade nuxt from 2.12.0 to 2.12.1 OpenLightingProject/open-fixture-library#1247

Merged

[Snyk] Upgrade nuxt from 2.11.0 to 2.12.1 titonobre/fanweekend.pt#14

Merged

pi0 mentioned this pull request Apr 2, 2020

Allow modules to differentiate between server starting or building #7164

Closed

pi0 mentioned this pull request Jul 10, 2020

Express with my nuxt app? nuxt/create-nuxt-app#563

Open

pi0 mentioned this pull request Sep 30, 2020

runtimeConfig with programmatic usage #8136

Closed

danielroe added the 2.x label Jan 18, 2023

		@@ -1,3 +1,12 @@
		import { loadNuxtConfig } from '@nuxt/config'
		import Nuxt from './nuxt'

Uh oh!

Conversation

pi0 commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Types of changes

Description

Checklist:

Uh oh!

pi0 commented Jan 14, 2020

Uh oh!

codecov-io commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kevinmarrec commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

clarkdo left a comment

Choose a reason for hiding this comment

Uh oh!

clarkdo Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pi0 Jan 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clarkdo Jan 15, 2020

Choose a reason for hiding this comment

Uh oh!

atinux Jan 16, 2020

Choose a reason for hiding this comment

Uh oh!

pi0 Jan 16, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

clarkdo commented Jan 17, 2020

Uh oh!

pi0 commented Jan 17, 2020

Uh oh!

crutch12 commented Sep 30, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

pi0 commented Jan 14, 2020 •

edited

Loading

codecov-io commented Jan 14, 2020 •

edited

Loading

kevinmarrec commented Jan 14, 2020 •

edited

Loading

clarkdo Jan 14, 2020 •

edited

Loading

pi0 Jan 15, 2020 •

edited

Loading