fix(wording): reconcile Pattern Lab vs PatternLab

bmuenzenmeyer · bmuenzenmeyer · commit f3d1e0d80758 · 2018-05-18T15:34:23.000-05:00
diff --git a/packages/cli/.gitignore b/packages/cli/.gitignore
@@ -67,7 +67,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-# PatternLab CLI specific
+# Pattern Lab CLI specific
 
 .DS_Store
 latest-change.txt
diff --git a/packages/cli/bin/archive.js b/packages/cli/bin/archive.js
@@ -8,7 +8,7 @@ const debug = require('./utils').debug;
 /**
  * @func exportPatterns
  * @desc Exports the patterns into the patternExportDirectory.
- * @param {object} config - The passed PatternLab config.
+ * @param {object} config - The passed Pattern Lab config.
  */
 function exportPatterns(config) {
 	if (!isValidConfig) {
diff --git a/packages/cli/bin/ask.js b/packages/cli/bin/ask.js
@@ -8,7 +8,7 @@ const ask = inquirer.prompt;
 
 /**
  * @func init
- * @desc Initiates a PatternLab project by getting user input through inquiry. Scaffolds the project and download mandatory files
+ * @desc Initiates a Pattern Lab project by getting user input through inquiry. Scaffolds the project and download mandatory files
  * @param {object} options - Options passed in from CLI
  * @param {boolean} options.force - Flag whether to force install in existing project directory. May overwrite stuff.
  */
diff --git a/packages/cli/bin/build.js b/packages/cli/bin/build.js
@@ -5,8 +5,8 @@ const isValidConfig = require('./validate-config');
 
 /**
  * @func build
- * @desc Init patternLab core and build the PatternLab files.
- * @param {object} config - The passed PatternLab config.
+ * @desc Init patternLab core and build the Pattern Lab files.
+ * @param {object} config - The passed Pattern Lab config.
  * @param {object} options - Additional opts to specify build mode.
  */
 function build(config, options) {
@@ -16,7 +16,7 @@ function build(config, options) {
 		);
 	}
 
-	// Initiate PatternLab core with the config
+	// Initiate Pattern Lab core with the config
 	const patternLab = pl(config);
 
 	/**
diff --git a/packages/cli/bin/cli-actions/build.js b/packages/cli/bin/cli-actions/build.js
@@ -10,7 +10,7 @@ const build = options =>
 			const config = yield resolveConfig(options.parent.config);
 			yield copyFiles(config.paths);
 			yield buildPatterns(config, options);
-			info(`build: Yay, your PatternLab project was successfully built ☺`);
+			info(`build: Yay, your Pattern Lab project was successfully built ☺`);
 		} catch (err) {
 			error(err);
 		}
diff --git a/packages/cli/bin/cli-actions/help.js b/packages/cli/bin/cli-actions/help.js
@@ -3,8 +3,8 @@ module.exports = () => {
 	/* eslint-disable */
 	console.log(`
   Examples:
-    $ patternlab init # Initialize a PatternLab project.');
-    $ patternlab <cmd> # Builds the PatternLab from the current dir');
-    $ patternlab <cmd> --config <path/to/patternlab-config> # PatternLab from a config in a specified directory');`);
+    $ patternlab init # Initialize a Pattern Lab project.');
+    $ patternlab <cmd> # Builds Pattern Lab from the current dir');
+    $ patternlab <cmd> --config <path/to/patternlab-config> # Pattern Lab from a config in a specified directory');`);
 	/* eslint-enable */
 };
diff --git a/packages/cli/bin/cli-actions/init.js b/packages/cli/bin/cli-actions/init.js
@@ -33,7 +33,7 @@ const init = options =>
 		 * 5. Save patternlab-config.json in projectDir
 		 */
 		const spinner = ora(
-			`Setting up PatternLab project in ${projectDir}`
+			`Setting up Pattern Lab in ${projectDir}`
 		).start();
 		let patternlabConfig = replaceConfigPaths(
 			defaultPatternlabConfig,
@@ -63,7 +63,7 @@ const init = options =>
 		); // 5
 
 		spinner.succeed(
-			`⊙ patternlab → Yay ☺. PatternLab Node was successfully initialised in ${projectDir}`
+			`⊙ patternlab → Yay ☺. Pattern Lab Node was successfully initialized in ${projectDir}`
 		);
 		return true;
 	});
diff --git a/packages/cli/bin/cli-actions/version.js b/packages/cli/bin/cli-actions/version.js
@@ -2,5 +2,5 @@
 const patternlab = require('@pattern-lab/core');
 
 module.exports = ({ version }) => {
-  `${version} (PatternLab Node Core version: ${patternlab.getVersion()})`;
+  `${version} (Pattern Lab Node Core version: ${patternlab.getVersion()})`;
 };
diff --git a/packages/cli/bin/copy-source-files.js b/packages/cli/bin/copy-source-files.js
@@ -6,7 +6,7 @@ const wrapAsync = require('./utils').wrapAsync;
 /**
  * @func copyFilesFromSourceToPublic
  * @desc Copies files from the source path to the public path.
- * @param {object} paths - The passed PatternLab config paths member.
+ * @param {object} paths - The passed Pattern Lab config paths member.
  * @return {Array}
  */
 const copyFilesFromSourceToPublic = paths =>
diff --git a/packages/cli/bin/inquiries/edition.js b/packages/cli/bin/inquiries/edition.js
@@ -6,7 +6,7 @@ const editionSetup = [
 	{
 		type: 'input',
 		name: 'project_root',
-		message: 'Please specify a directory for your PatternLab project.',
+		message: 'Please specify a directory for your Pattern Lab project.',
 		default: () => './',
 	},
 	{
diff --git a/packages/cli/bin/patternlab.js b/packages/cli/bin/patternlab.js
@@ -49,32 +49,32 @@ cli
 
 /**
  * build
- * @desc Setup patternlab's `build` cmd
+ * @desc Setup Pattern Lab's `build` cmd
  */
 cli
 	.command('build')
 	.alias('compile')
-	.description('Build the PatternLab. Optionally (re-)build only the patterns')
+	.description('Build Pattern Lab. Optionally (re-)build only the patterns')
 	.option('-p, --patterns-only', 'Whether to only build patterns')
 	.action(build);
 
 /**
  * export
- * @desc Export a PatternLab patterns into a compressed format
+ * @desc Export a Pattern Lab patterns into a compressed format
  */
 cli
 	.command('export')
-	.description('Export a PatternLab patterns into a compressed format')
+	.description('Export Pattern Lab patterns into a compressed format')
 	.action(exportPatterns);
 
 /**
  * init
- * @desc Initialize a PatternLab project from scratch or import an edition and/or starterkit
+ * @desc Initialize a Pattern Lab project from scratch or import an edition and/or starterkit
  */
 cli
 	.command('init')
 	.description(
-		'Initialize a PatternLab project from scratch or import an edition and/or starterkit'
+		'Initialize a Pattern Lab project from scratch or import an edition and/or starterkit'
 	)
 	.option('-p, --project-dir <path>', 'Specify a project directory')
 	.option('-e, --edition <name>', 'Specify an edition to install')
diff --git a/packages/cli/bin/replace-config.js b/packages/cli/bin/replace-config.js
@@ -5,7 +5,7 @@ const _ = require('lodash');
 /**
  * @func replaceConfigPaths
  * @desc Immutable replace source and public paths in the passed config.
- * @param {config} config - The passed PatternLab config.
+ * @param {config} config - The passed Pattern Lab config.
  * @param {string} projectDir - The project directory path, defaults to ./
  * @param {string} sourceDir - The source root directory path.
  * @param {string} publicDir - The public root directory path.
diff --git a/packages/cli/bin/resolve-config.js b/packages/cli/bin/resolve-config.js
@@ -7,7 +7,7 @@ const wrapAsync = require('./utils').wrapAsync;
 
 /**
  * @func resolveConfig
- * @desc Resolves the given PatternLab config file.
+ * @desc Resolves the given Pattern Lab config file.
  * @param {string} [configPath=./patternlab-config.json] - Path to the patternlab-config.json. Defaults to project dir.
  * @return {object|boolean} Returns the config object or false otherwise.
  */
@@ -26,15 +26,15 @@ function resolveConfig(configPath) {
 
 		/**
 		 * Setup the config.
-		 * 1. Check if user specified custom PatternLab config location
+		 * 1. Check if user specified custom Pattern Lab config location
 		 * 2. Read the config file
 		 */
 		try {
 			const absoluteConfigPath = path.resolve(configPath); // 1
 			return yield readJsonAsync(absoluteConfigPath); // 2
 		} catch (err) {
 			error(
-				'resolveConfig: Got an error during parsing your PatternLab config. Please make sure your config file exists.'
+				'resolveConfig: Got an error during parsing your Pattern Lab config. Please make sure your config file exists.'
 			);
 			error(err);
 			return false;
diff --git a/packages/cli/bin/scaffold.js b/packages/cli/bin/scaffold.js
@@ -5,7 +5,7 @@ const mkdirsAsync = require('./utils').mkdirsAsync;
 
 /**
  * @func scaffold
- * @desc Generate file and folder structure for a PatternLab project
+ * @desc Generate file and folder structure for a Pattern Lab project
  * @param {string} projectDir - The project root directory path.
  * @param {string} sourceDir - The source root directory path.
  * @param {string} publicDir - The public root directory path.
diff --git a/packages/cli/bin/serve.js b/packages/cli/bin/serve.js
@@ -7,8 +7,8 @@ const { error, info } = require('./utils');
 
 /**
  * @func serve
- * @desc Start a browser-sync server in the PatternLab public dir
- * @param {object} config - The passed PatternLab config
+ * @desc Start a browser-sync server in the Pattern Lab public dir
+ * @param {object} config - The passed Pattern Lab config
  */
 function serve(config) {
 	if (!isValidConfig) {
@@ -22,15 +22,15 @@ function serve(config) {
 		_.isEmpty(config.paths.public.root)
 	) {
 		throw new TypeError(
-			'serve: config.paths.public.root is empty or does not exist. Please check your PatternLab config.'
+			'serve: config.paths.public.root is empty or does not exist. Please check your Pattern Lab config.'
 		);
 	}
 	if (
 		!_.has(config, 'paths.source.root') ||
 		_.isEmpty(config.paths.source.root)
 	) {
 		throw new TypeError(
-			'serve: config.paths.source.root is empty or does not exist. Please check your PatternLab config.'
+			'serve: config.paths.source.root is empty or does not exist. Please check your Pattern Lab config.'
 		);
 	}
 
diff --git a/packages/cli/readme.md b/packages/cli/readme.md
@@ -1,4 +1,4 @@
-# PatternLab Node CLI
+# Pattern Lab Node CLI
 
 > Command-line interface (CLI) for the patternlab-node core.
 
@@ -15,8 +15,8 @@
 `yarn add @pattern-lab/cli --dev`
 
 ## Getting Started
-1. In order to use PatternLab you need to initialize a PatternLab project with `patternlab init`. The CLI will ask you some setup question and scaffold your project based on it.
-2. Build your patterns use `patternlab build`. The PatternLab CLI will assume that the `patternlab-config.json` is in the project root. Othewise specify a custom path to config with `patternlab build --config path/to/config`
+1. In order to use Pattern Lab you need to initialize a Pattern Lab project with `patternlab init`. The CLI will ask you some setup question and scaffold your project based on it.
+2. Build your patterns use `patternlab build`. The Pattern Lab CLI will assume that the `patternlab-config.json` is in the project root. Othewise specify a custom path to config with `patternlab build --config path/to/config`
 3. To view your patterns in the browser preview `patternlab serve` or again specify a custom config location `patternlab serve --config path/to/config`
 4. To export your patterns in the browser preview `patternlab export` or again specify a custom config location `patternlab export --config path/to/config`
 
@@ -25,9 +25,9 @@
 ```
 Usage: patternlab <cmd> [options]
 	Commands:
-		build|compile [options]   Build the PatternLab. Optionally (re-)build only the patterns
-		export                    Export a PatternLab patterns into a compressed format
-		init [options]            Initialize a PatternLab project from scratch or import an edition and/or starterkit
+		build|compile [options]   Build Pattern Lab. Optionally (re-)build only the patterns
+		export                    Export a Pattern Lab patterns into a compressed format
+		init [options]            Initialize a Pattern Lab project from scratch or import an edition and/or starterkit
 	    install|add [options]     Installs Pattern Lab related modules like starterkits or plugins
 		serve|browse [options]    Starts a server to inspect files in browser
 
@@ -39,22 +39,22 @@ Usage: patternlab <cmd> [options]
 		--silent             Turn off console logs
 ```
 
-### Build/Compile PatternLab
+### Build/Compile Pattern Lab
 ```
 Usage: build|compile [options]
 
-Build the PatternLab. Optionally (re-)build only the patterns
+Build Pattern Lab. Optionally (re-)build only the patterns
 
 	Options:
 		-h, --help           output usage information
 		-p, --patterns-only  Whether to only build patterns
 ```
 
-### Initialize PatternLab
+### Initialize Pattern Lab
 ```
 Usage: init [options]
 
-Initialize a PatternLab project from scratch or import an edition and/or starterkit
+Initialize a Pattern Lab project from scratch or import an edition and/or starterkit
 Passing no options starts the init in interactive mode
 
 	Options:
@@ -64,7 +64,7 @@ Passing no options starts the init in interactive mode
 		-k, --starterkit <name>   Specify a starterkit to install. Default: starterkit-mustache-base
 ```
 
-### Serve PatternLab
+### Serve Pattern Lab
 ```
 Usage: serve|browse [options]
 
@@ -76,11 +76,11 @@ Starts a server to inspect files in browser
 		-w, --watch  Start watching for changes
 ```
 
-### Export PatternLab
+### Export Pattern Lab
 ```
 Usage: export [options]
 
-Export a PatternLab patterns into a compressed format
+Export a Pattern Lab patterns into a compressed format
 
 	Options:
 		-h, --help  output usage information
@@ -101,9 +101,9 @@ Installs Pattern Lab related modules like starterkits or plugins
 
 ## Examples
 ```
-    $ patternlab init # Initialize a PatternLab project.
-    $ patternlab build # Builds PatternLab from the current dir
-    $ patternlab build --config <path/to/patternlab-config> # Builds PatternLab from different project directory
+    $ patternlab init # Initialize a Pattern Lab project.
+    $ patternlab build # Builds Pattern Lab from the current dir
+    $ patternlab build --config <path/to/patternlab-config> # Builds Pattern Lab from different project directory
 ```
 ## License
 MIT © [Raphael Okon](https://github.com/raphaelokon)
diff --git a/packages/cli/test/cli-init.test.js b/packages/cli/test/cli-init.test.js
@@ -21,7 +21,7 @@ tap.test('Init ->', t =>
 		]);
 		t.ok(
 			exists.sync(path.resolve(projectRoot)),
-			'should initialize a PatternLab project'
+			'should initialize a Pattern Lab project'
 		);
 		t.ok(exists.sync(path.resolve(projectRoot, 'source')), 'with a source dir');
 		t.ok(exists.sync(path.resolve(projectRoot, 'public')), 'with a public dir');

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ const build = options =>`
`10`	`10`	`const config = yield resolveConfig(options.parent.config);`
`11`	`11`	`yield copyFiles(config.paths);`
`12`	`12`	`yield buildPatterns(config, options);`
`13`		- info(`build: Yay, your PatternLab project was successfully built ☺`);
	`13`	+ info(`build: Yay, your Pattern Lab project was successfully built ☺`);
`14`	`14`	`} catch (err) {`
`15`	`15`	`error(err);`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ const editionSetup = [`
`6`	`6`	`{`
`7`	`7`	`type: 'input',`
`8`	`8`	`name: 'project_root',`
`9`		`- message: 'Please specify a directory for your PatternLab project.',`
	`9`	`+ message: 'Please specify a directory for your Pattern Lab project.',`
`10`	`10`	`default: () => './',`
`11`	`11`	`},`
`12`	`12`	`{`