create-lwr 0.9.0-alpha.9 → 0.9.0

package/README.md

@@ -3,12 +3,14 @@
 ## Scaffolding Your First LWR Project
 
 > **Compatibility Note:**
-> LWR requires [Node.js](https://nodejs.org/en/) version >=14.0.0.
+> LWR requires [Node.js](https://nodejs.org/en/) version >=16.0.0 <20.
+
+> **Note:** If you've previously installed `create-lwr` globally, we recommend you uninstall the package using `npm uninstall -g create-lwr` or `yarn global remove create-lwr` to ensure the latest version is always used.
 
 With NPM:
 
 ```bash
-$ npm init lwr
+$ npm init lwr@latest
 ```
 
 With Yarn:
@@ -30,7 +32,4 @@ npm init lwr@latest my-lwr-app -- --template lwc-ts
 
 # yarn
 yarn create lwr my-lwr-app --template lwc-ts
-
-# pnpm
-pnpx create-lwr my-lwr-app --template lwc-ts
 ```

package/build/es/index.js

@@ -5,13 +5,18 @@ import minimist from 'minimist';
 import { emptyDir, copy, pkgFromUserAgent, promptForAnswers, updateLwrVersion } from './utils.js';
 import { dirname } from 'path';
 import { fileURLToPath } from 'url';
+import { dim } from 'kolorist';
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const cwd = process.cwd();
+const rooDir = path.join(__dirname, '../../');
+const rootPkg = JSON.parse(fs.readFileSync(path.join(rooDir, `package.json`), 'utf-8'));
+const LWR_VERSION = rootPkg.version;
 const argv = minimist(process.argv.slice(2), { string: ['_'] });
 const renameFiles = {
     _gitignore: '.gitignore',
 };
 export async function init() {
+    console.log(dim(`create-lwr v${LWR_VERSION}`));
     const targetDir = argv._[0];
     const metadata = {
         targetDir,
@@ -72,6 +77,11 @@ function writePackageFile(projectRoot, templateDir, packageName, metadata) {
     write(projectRoot, templateDir, 'package.json', JSON.stringify(pkg, null, 2));
     const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
     const pkgManager = pkgInfo ? pkgInfo.name : 'npm';
+    if (pkgManager === 'yarn') {
+        // Set nodeLinker in .yarnrc.yml if yarn is the selected package manager.
+        // LWR does not work when included in yarn pnp.
+        write(projectRoot, templateDir, '.yarnrc.yml', 'nodeLinker: node-modules');
+    }
     return pkgManager;
 }
 function logResult(projectRoot, pkgManager) {

package/package.json

@@ -3,16 +3,17 @@
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
-        "url": "https://github.com/salesforce/lwr.git",
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr.git",
         "directory": "packages/create-lwr"
     },
     "bugs": {
-        "url": "https://github.com/salesforce/lwr/issues"
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr/issues"
     },
     "bin": {
         "create-lwr": "build/es/index.js"
     },
     "scripts": {
+        "build": "tsc -b",
         "local:bin": "node ./build/es/index.js"
     },
     "license": "MIT",
@@ -21,7 +22,7 @@
     },
     "type": "module",
     "types": "build/es/index.d.ts",
-    "version": "0.9.0-alpha.9",
+    "version": "0.9.0",
     "module": "build/es/index.js",
     "main": "build/cjs/index.cjs",
     "files": [
@@ -35,9 +36,15 @@
         "require": "./build/cjs/index.cjs"
     },
     "dependencies": {
-        "kolorist": "^1.5.0",
-        "minimist": "^1.2.6",
-        "prompts": "^2.4.1"
+        "kolorist": "^1.7.0",
+        "minimist": "^1.2.8",
+        "prompts": "^2.4.2"
     },
-    "gitHead": "93522592d25375bb20da156f864d153ffcd3ec88"
+    "engines": {
+        "node": ">=16.0.0 <20"
+    },
+    "volta": {
+        "extends": "../../package.json"
+    },
+    "gitHead": "4e42b0dc5453f92b36b42aa8132c5bc281e616b7"
 }

package/template-lwc/README.md

@@ -7,11 +7,10 @@ The **LWC Boilerplate** example contains the minimum code needed to get a simple
 The directory structure looks like this:
 
 ```
-scripts/
-  └── start-server.mjs  // create and start server
 src/
   ├── assets/           // static assets
   │   └── recipes-logo.png
+  |   └── favicon.ico
   └── modules/          // lwc modules
       └── example/
           └── app/
@@ -36,22 +35,36 @@ The LWR server is configured in `lwr.config.json`, at the root of the project. T
             "path": "/",
             "rootComponent": "example/app"
         }
+    ],
+    "assets": [
+        {
+            "alias": "assetsDir",
+            "dir": "$rootDir/src/assets",
+            "urlPath": "/public/assets"
+        },
+        {
+            "alias": "favicon",
+            "file": "$rootDir/src/assets/favicon.ico",
+            "urlPath": "/favicon.ico"
+        }
     ]
 }
 ```
 
-## Running the Project
+## Running the Project in dev Mode
 
 ```bash
 yarn install
-yarn build
-yarn start # prod mode and ESM format
+yarn dev # dev:compat for AMD format
 ```
 
 Open the site at [http://localhost:3000](http://localhost:3000)
 
-To start the project in a different mode:
+## Statically Generate and Preview the Site
 
--   dev: `yarn dev`
--   compat: `yarn start:compat`
--   prod-compat: `yarn start:prod-compat`
+```bash
+yarn build # dev:prod-compat for AMD format
+yarn start
+```
+
+Open the site at [http://localhost:3000](http://localhost:3000)

package/template-lwc/lwr.config.json

@@ -6,5 +6,17 @@
             "path": "/",
             "rootComponent": "example/app"
         }
+    ],
+    "assets": [
+        {
+            "alias": "assetsDir",
+            "dir": "$rootDir/src/assets",
+            "urlPath": "/public/assets"
+        },
+        {
+            "alias": "favicon",
+            "file": "$rootDir/src/assets/favicon.ico",
+            "urlPath": "/favicon.ico"
+        }
     ]
 }

package/template-lwc/package.json

@@ -5,17 +5,23 @@
     "private": true,
     "type": "module",
     "scripts": {
-        "clean": "rm -rf __lwr_cache__",
-        "dev": "lwr serve",
-        "start": "lwr serve --mode prod",
-        "start:compat": "lwr serve --mode compat",
-        "start:prod-compat": "lwr serve --mode prod-compat"
+        "clean": "rm -rf node_modules __lwr_cache__ site",
+        "dev": "lwr dev",
+        "dev:compat": "lwr dev --mode compat",
+        "build": "lwr build --clean",
+        "build:prod-compat": "lwr build --clean --mode prod-compat",
+        "start": "lwr start",
+        "stage": "yarn build && yarn start",
+        "stage:prod-compat": "yarn build:prod-compat && yarn start"
     },
     "dependencies": {
-        "lwc": "2.33.0",
-        "lwr": "0.8.0-alpha.5"
+        "lwc": "2.38.1",
+        "lwr": "latest"
     },
     "engines": {
-        "node": ">=14.15.4 <19"
+        "node": ">=16.0.0 <20"
+    },
+    "volta": {
+        "node": "16.19.1"
     }
 }

package/template-lwc-ts/README.md

@@ -7,11 +7,10 @@ The **LWC TS Boilerplate** example contains the minimum code needed to get a sim
 The directory structure looks like this:
 
 ```
-scripts/
-  └── start-server.mjs  // create and start server
 src/
   ├── assets/           // static assets
   │   └── recipes-logo.png
+  |   └── favicon.ico
   └── modules/          // lwc modules
       └── example/
           └── app/
@@ -36,22 +35,36 @@ The LWR server is configured in `lwr.config.json`, at the root of the project. T
             "path": "/",
             "rootComponent": "example/app"
         }
+    ],
+    "assets": [
+        {
+            "alias": "assetsDir",
+            "dir": "$rootDir/src/assets",
+            "urlPath": "/public/assets"
+        },
+        {
+            "alias": "favicon",
+            "file": "$rootDir/src/assets/favicon.ico",
+            "urlPath": "/favicon.ico"
+        }
     ]
 }
 ```
 
-## Running the Project
+## Running the Project in dev Mode
 
 ```bash
 yarn install
-yarn build
-yarn start # prod mode and ESM format
+yarn dev # dev:compat for AMD format
 ```
 
 Open the site at [http://localhost:3000](http://localhost:3000)
 
-To start the project in a different mode:
+## Statically Generate and Preview the Site
 
--   dev: `yarn dev`
--   compat: `yarn start:compat`
--   prod-compat: `yarn start:prod-compat`
+```bash
+yarn build # dev:prod-compat for AMD format
+yarn start
+```
+
+Open the site at [http://localhost:3000](http://localhost:3000)

package/template-lwc-ts/lwr.config.json

@@ -6,5 +6,17 @@
             "path": "/",
             "rootComponent": "example/app"
         }
+    ],
+    "assets": [
+        {
+            "alias": "assetsDir",
+            "dir": "$rootDir/src/assets",
+            "urlPath": "/public/assets"
+        },
+        {
+            "alias": "favicon",
+            "file": "$rootDir/src/assets/favicon.ico",
+            "urlPath": "/favicon.ico"
+        }
     ]
 }

package/template-lwc-ts/package.json

@@ -5,17 +5,23 @@
     "private": true,
     "type": "module",
     "scripts": {
-        "clean": "rm -rf __lwr_cache__",
-        "dev": "lwr serve",
-        "start": "lwr serve --mode prod",
-        "start:compat": "lwr serve --mode compat",
-        "start:prod-compat": "lwr serve --mode prod-compat"
+        "clean": "rm -rf node_modules __lwr_cache__ site",
+        "dev": "lwr dev",
+        "dev:compat": "lwr dev --mode compat",
+        "build": "lwr build --clean",
+        "build:prod-compat": "lwr build --clean --mode prod-compat",
+        "start": "lwr start",
+        "stage": "yarn build && yarn start",
+        "stage:prod-compat": "yarn build:prod-compat && yarn start"
     },
     "dependencies": {
-        "lwc": "2.33.0",
-        "lwr": "0.8.0-alpha.5"
+        "lwc": "2.38.1",
+        "lwr": "latest"
     },
     "engines": {
-        "node": ">=14.15.4 <19"
+        "node": ">=16.0.0 <20"
+    },
+    "volta": {
+        "node": "16.19.1"
     }
 }

package/template-markdown-static-site/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/template-markdown-static-site/README.md

@@ -7,10 +7,9 @@ The **Static Site** example contains the minimum code needed to get up and runni
 The directory structure looks like this:
 
 ```
-scripts/
-  └── start-server.mjs  // create and start server
 src/
   ├── assets/           // static assets
+  |   └── favicon.ico
   │   └── css/
   │       └── main.css
   └── content/          // site pages
@@ -43,22 +42,36 @@ The LWR server is configured in `lwr.config.json`, at the root of the project. T
             "contentTemplate": "$contentDir/about.md",
             "layoutTemplate": "$layoutsDir/main_layout.njk"
         }
+    ],
+    "assets": [
+        {
+            "alias": "assetsDir",
+            "dir": "$rootDir/src/assets",
+            "urlPath": "/public/assets"
+        },
+        {
+            "alias": "favicon",
+            "file": "$rootDir/src/assets/favicon.ico",
+            "urlPath": "/favicon.ico"
+        }
     ]
 }
 ```
 
-## Running the Project
+## Running the Project in dev Mode
 
 ```bash
 yarn install
-yarn build
-yarn start # prod mode and ESM format
+yarn dev
 ```
 
 Open the site at [http://localhost:3000](http://localhost:3000)
 
-To start the project in a different mode:
+## Statically Generate and Preview the Site
 
--   dev: `yarn dev`
--   compat: `yarn start:compat`
--   prod-compat: `yarn start:prod-compat`
+```bash
+yarn build
+yarn start
+```
+
+Open the site at [http://localhost:3000](http://localhost:3000)

package/template-markdown-static-site/lwr.config.json

@@ -13,5 +13,17 @@
             "contentTemplate": "$contentDir/about.md",
             "layoutTemplate": "$layoutsDir/main_layout.njk"
         }
+    ],
+    "assets": [
+        {
+            "alias": "assetsDir",
+            "dir": "$rootDir/src/assets",
+            "urlPath": "/public/assets"
+        },
+        {
+            "alias": "favicon",
+            "file": "$rootDir/src/assets/favicon.ico",
+            "urlPath": "/favicon.ico"
+        }
     ]
 }

package/template-markdown-static-site/package.json

@@ -5,17 +5,19 @@
     "private": true,
     "type": "module",
     "scripts": {
-        "clean": "rm -rf __lwr_cache__",
-        "dev": "lwr serve",
-        "start": "lwr serve --mode prod",
-        "start:compat": "lwr serve --mode compat",
-        "start:prod-compat": "lwr serve --mode prod-compat"
+        "clean": "rm -rf node_modules __lwr_cache__ site",
+        "dev": "lwr dev",
+        "build": "lwr build --clean",
+        "start": "lwr start",
+        "stage": "yarn build && yarn start"
     },
     "dependencies": {
-        "lwc": "2.33.0",
-        "lwr": "0.8.0-alpha.5"
+        "lwr": "latest"
     },
     "engines": {
-        "node": ">=14.15.4 <19"
+        "node": ">=16.0.0 <20"
+    },
+    "volta": {
+        "node": "16.19.1"
     }
 }