move out from devOptions to buildOptions (#1337)

* move out to build options

* Update config.ts

* Update config.ts

docs/10-reference.md

@@ -176,8 +176,6 @@ Options:
 
 - **`devOptions.port`** | `number` | Default: `8080`
   - The port number to run the dev server on.
-- **`devOptions.out`** | `string` | Default: `"build"`
-  - The local directory that we output your final build to.
 - **`devOptions.bundle`** | `boolean`
   - Create an optimized, bundled build for production.
   - You must have [Parcel](https://parceljs.org/) as a dev dependency in your project.
@@ -198,6 +196,9 @@ Options:
   - When HMR is enabled, toggles whether or not a browser overlay should display javascript errors.
 - **`devOptions.secure`** | `boolean`
   - Toggles whether or not Snowpack dev server should use HTTPS with HTTP2 enabled.
+- **`devOptions.out`** | `string` | Default: `"build"`
+  - _NOTE:_ Deprecated, see `buildOptions.out`.
+  - The local directory that we output your final build to.
 
 #### `config.buildOptions`
 
@@ -218,6 +219,8 @@ buildOptions: {
 
 Options:
 
+- **`buildOptions.out`** | `string` | Default: `"build"`
+  - The local directory that we output your final build to.
 - **`buildOptions.baseUrl`** | `string` | Default: `/`
   - In your HTML, replace all instances of `%PUBLIC_URL%` with this (inspired by the same [Create React App](https://create-react-app.dev/docs/using-the-public-folder/) concept). This is useful if your app will be deployed to a subdirectory. _Note: if you have `homepage` in your `package.json`, Snowpack will actually pick up on that, too._
 - **`buildOptions.clean`** | `boolean` | Default: `false`

snowpack/src/commands/build.ts

@@ -224,7 +224,7 @@ class FileBuilder {
         // in the final build, so we mark them to be written to disk at the next step.
         if (isProxyImport) {
           if (isAbsoluteUrlPath) {
-            this.filesToProxy.push(path.resolve(this.config.devOptions.out, resolvedImportPath));
+            this.filesToProxy.push(path.resolve(this.config.buildOptions.out, resolvedImportPath));
           } else {
             this.filesToProxy.push(path.resolve(path.dirname(outLoc), resolvedImportPath));
           }
@@ -239,7 +239,7 @@ class FileBuilder {
         if (isAbsoluteUrlPath) {
           resolvedImportUrl = relativeURL(
             path.dirname(outLoc),
-            path.resolve(this.config.devOptions.out, resolvedImportPath),
+            path.resolve(this.config.buildOptions.out, resolvedImportPath),
           );
         }
         // Make sure that a relative URL always starts with "./"
@@ -264,7 +264,7 @@ class FileBuilder {
   async getProxy(originalFileLoc: string) {
     const proxiedCode = this.output[originalFileLoc];
     const proxiedUrl = originalFileLoc
-      .substr(this.config.devOptions.out.length)
+      .substr(this.config.buildOptions.out.length)
       .replace(/\\/g, '/');
     return wrapImportProxy({
       url: proxiedUrl,
@@ -293,7 +293,7 @@ export async function command(commandOptions: CommandOptions) {
     }
   }
 
-  const buildDirectoryLoc = config.devOptions.out;
+  const buildDirectoryLoc = config.buildOptions.out;
   const internalFilesBuildLoc = path.join(buildDirectoryLoc, config.buildOptions.metaDir);
 
   if (config.buildOptions.clean) {

snowpack/src/config.ts

@@ -45,14 +45,14 @@ const DEFAULT_CONFIG: Partial<SnowpackConfig> = {
     hostname: 'localhost',
     port: 8080,
     open: 'default',
-    out: 'build',
     output: 'dashboard',
     fallback: 'index.html',
     hmrDelay: 0,
     hmrPort: undefined,
     hmrErrorOverlay: true,
   },
   buildOptions: {
+    out: 'build',
     baseUrl: '/',
     webModulesUrl: '/web_modules',
     clean: false,
@@ -93,7 +93,6 @@ const configSchema = {
       properties: {
         secure: {type: 'boolean'},
         port: {type: 'number'},
-        out: {type: 'string'},
         fallback: {type: 'string'},
         bundle: {type: 'boolean'},
         open: {type: 'string'},
@@ -102,6 +101,8 @@ const configSchema = {
         hmrDelay: {type: 'number'},
         hmrPort: {type: 'number'},
         hmrErrorOverlay: {type: 'boolean'},
+        // DEPRECATED
+        out: {type: 'string'},
       },
     },
     installOptions: {
@@ -143,6 +144,7 @@ const configSchema = {
     buildOptions: {
       type: ['object'],
       properties: {
+        out: {type: 'string'},
         baseUrl: {type: 'string'},
         clean: {type: 'boolean'},
         metaDir: {type: 'string'},
@@ -560,11 +562,16 @@ function normalizeAlias(config: SnowpackConfig, cwd: string, createMountAlias: b
 function normalizeConfig(config: SnowpackConfig): SnowpackConfig {
   const cwd = process.cwd();
   config.knownEntrypoints = (config as any).install || [];
-  config.devOptions.out = path.resolve(cwd, config.devOptions.out);
+  // @ts-ignore
+  if (config.devOptions.out) {
+    logger.debug('`devOptions.out` is now `buildOptions.out`! `devOptions.out` will be deprecated in the next major release.');
+  };
+  // @ts-ignore
+  config.buildOptions.out = path.resolve(cwd, config.buildOptions.out || config.devOptions.out);
   config.installOptions.rollup = config.installOptions.rollup || {};
   config.installOptions.rollup.plugins = config.installOptions.rollup.plugins || [];
   config.exclude = Array.from(
-    new Set([...ALWAYS_EXCLUDE, `${config.devOptions.out}/**/*`, ...config.exclude]),
+    new Set([...ALWAYS_EXCLUDE, `${config.buildOptions.out}/**/*`, ...config.exclude]),
   );
 
   if (!config.proxy) {

snowpack/src/types/snowpack.ts

@@ -135,7 +135,6 @@ export interface SnowpackConfig {
     secure: boolean;
     hostname: string;
     port: number;
-    out: string;
     fallback: string;
     open: string;
     output: 'stream' | 'dashboard';
@@ -146,6 +145,7 @@ export interface SnowpackConfig {
   };
   installOptions: InstallOptions;
   buildOptions: {
+    out: string;
     baseUrl: string;
     webModulesUrl: string;
     clean: boolean;

test/build/config-out/__snapshots__

@@ -15,12 +15,12 @@ exports[`snowpack build config-out: build/package.json 1`] = `
   \\"private\\": true,
   \\"version\\": \\"1.0.1\\",
   \\"name\\": \\"@snowpack/test-config-out\\",
-  \\"description\\": \\"Test for devOptions.out\\",
+  \\"description\\": \\"Test for buildOptions.out\\",
   \\"scripts\\": {
     \\"testbuild\\": \\"snowpack build\\"
   },
   \\"snowpack\\": {
-    \\"devOptions\\": {
+    \\"buildOptions\\": {
       \\"out\\": \\"TEST_BUILD_OUT\\"
     },
     \\"exclude\\": [

test/build/config-out/package.json

@@ -2,12 +2,12 @@
   "private": true,
   "version": "1.0.1",
   "name": "@snowpack/test-config-out",
-  "description": "Test for devOptions.out",
+  "description": "Test for buildOptions.out",
   "scripts": {
     "testbuild": "snowpack build"
   },
   "snowpack": {
-    "devOptions": {
+    "buildOptions": {
       "out": "TEST_BUILD_OUT"
     },
     "exclude": [