Renamed all placeholders, and added some new ones

JamesMessinger · JamesMessinger · commit 86cad168401f · 2020-03-15T08:40:58.000-05:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -35,7 +35,7 @@
 "type": "node",
 "request": "launch",
 "name": "Run CLI",
- "program": "${workspaceRoot}/bin/project-cli-name.js",
+ "program": "${workspaceRoot}/bin/my-cli.js",
 "args": [],
 "env":{
 "NODE_ENV": "development"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,10 @@
 Change Log
 ====================================================================================================
 All notable changes will be documented in this file.
-Friendly Project Name adheres to [Semantic Versioning](http://semver.org/).
+My Project Name adheres to [Semantic Versioning](http://semver.org/).
 
 
-[v1.0.0](https://github.com/JS-DevTools/project-package-name/tree/v1.0.0) (XXXX-XX-XX)
+[v1.0.0](https://github.com/MyGitHubOrg/my-package-name/tree/v1.0.0) (XXXX-XX-XX)
 ----------------------------------------------------------------------------------------------------
 
 Initial release 🎉
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ If you **don't** need a CLI, then:
 - `bin`
 - `src/cli`
 - `test/specs/cli.spec.js`
- - `test/utils/project-cli-name.js`
+ - `test/utils/my-cli.js`
 - Delete the following fields in `package.json`:
 - `bin`
 - `files.bin`
@@ -34,11 +34,14 @@ Replace all occurrences of the following placeholders in all files:
 
 |Placeholder |Description
 |:----------------------------------|:------------------------------------------------------------
-|`project-package-name` |This is the name of the NPM package. It should also match the GitHub repo name. It should be kebab-cased.
-|`project-cli-name` |The name of the CLI program for this project, if any.
-|`projectExportName` |The name of the library's default export, if any. This should be a valid JavaScript identifier name.
-|`Friendly Project Name` |This is the human friendly name of the project that is used in the ReadMe, descriptions, and docs pages
-|`This is the project description` |A short, human friendly description of the project that is used in the ReadMe and package.json
+|`MyGitHubOrg` |This is the name of the GitHub org for this repository, such as "JS-DevTools".
+|`MyTwitterAccount` |This is the name of the Twitter account associated with this project, such as "JSDevTools".
+|`@my-npm-scope` |This is the name of the NPM scope that the package will be published to, such as "@jsdevtools".
+|`my-package-name` |This is the name of the NPM package. It should also match the GitHub repo name. It should be kebab-cased.
+|`my-cli` |The name of the CLI program for this project, if any.
+|`myLibrary` |The name of the library's default export, if any. This should be a valid JavaScript identifier name.
+|`My Project Name` |This is the human friendly name of the project that is used in the ReadMe, descriptions, and docs pages
+|`The description of my library` |A short, human friendly description of the project that is used in the ReadMe and package.json
 
 
 
diff --git a/README_md b/README_md
@@ -1,15 +1,15 @@
-Friendly Project Name
+My Project Name
 ==============================================
-### This is the project description
+### The description of my library
 
-[![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://github.com/JS-DevTools/project-package-name/blob/master/.github/workflows/CI-CD.yaml)
-[![Build Status](https://github.com/JS-DevTools/project-package-name/workflows/CI-CD/badge.svg)](https://github.com/JS-DevTools/project-package-name/blob/master/.github/workflows/CI-CD.yaml)
+[![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://github.com/MyGitHubOrg/my-package-name/blob/master/.github/workflows/CI-CD.yaml)
+[![Build Status](https://github.com/MyGitHubOrg/my-package-name/workflows/CI-CD/badge.svg)](https://github.com/MyGitHubOrg/my-package-name/blob/master/.github/workflows/CI-CD.yaml)
 
-[![Coverage Status](https://coveralls.io/repos/github/JS-DevTools/project-package-name/badge.svg?branch=master)](https://coveralls.io/github/JS-DevTools/project-package-name)
-[![Dependencies](https://david-dm.org/JS-DevTools/project-package-name.svg)](https://david-dm.org/JS-DevTools/project-package-name)
+[![Coverage Status](https://coveralls.io/repos/github/MyGitHubOrg/my-package-name/badge.svg?branch=master)](https://coveralls.io/github/MyGitHubOrg/my-package-name)
+[![Dependencies](https://david-dm.org/MyGitHubOrg/my-package-name.svg)](https://david-dm.org/MyGitHubOrg/my-package-name)
 
-[![npm](https://img.shields.io/npm/v/@jsdevtools/project-package-name.svg)](https://www.npmjs.com/package/@jsdevtools/project-package-name)
-[![License](https://img.shields.io/npm/l/@jsdevtools/project-package-name.svg)](LICENSE)
+[![npm](https://img.shields.io/npm/v/@my-npm-scope/my-package-name.svg)](https://www.npmjs.com/package/@my-npm-scope/my-package-name)
+[![License](https://img.shields.io/npm/l/@my-npm-scope/my-package-name.svg)](LICENSE)
 
 
 
@@ -25,7 +25,7 @@ Example
 --------------------------
 
 ```javascript
-import projectExportName from "@jsdevtools/project-package-name";
+import myLibrary from "@my-npm-scope/my-package-name";
 
 // TODO: Add a usage example here
 ```
@@ -34,10 +34,10 @@ import projectExportName from "@jsdevtools/project-package-name";
 
 Installation
 --------------------------
-You can install Friendly Project Name via [npm](https://docs.npmjs.com/about-npm/).
+You can install My Project Name via [npm](https://docs.npmjs.com/about-npm/).
 
 ```bash
-npm install @jsdevtools/project-package-name
+npm install @my-npm-scope/my-package-name
 ```
 
 
@@ -50,13 +50,13 @@ TODO: Document the library's API and CLI usage
 
 Contributing
 --------------------------
-Contributions, enhancements, and bug-fixes are welcome! [File an issue](https://github.com/JS-DevTools/project-package-name/issues) on GitHub and [submit a pull request](https://github.com/JS-DevTools/project-package-name/pulls).
+Contributions, enhancements, and bug-fixes are welcome! [File an issue](https://github.com/MyGitHubOrg/my-package-name/issues) on GitHub and [submit a pull request](https://github.com/MyGitHubOrg/my-package-name/pulls).
 
 #### Building
 To build the project locally on your computer:
 
 1. __Clone this repo__<br>
-`git clone https://github.com/JS-DevTools/project-package-name.git`
+`git clone https://github.com/MyGitHubOrg/my-package-name.git`
 
 2. __Install dependencies__<br>
 `npm install`
@@ -71,7 +71,7 @@ To build the project locally on your computer:
 
 License
 --------------------------
-Friendly Project Name is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
+My Project Name is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
 
 
 
diff --git a/_config.yml b/_config.yml
@@ -1,15 +1,15 @@
-remote_theme: JS-DevTools/gh-pages-theme
+remote_theme: MyGitHubOrg/gh-pages-theme
 
-title: Friendly Project Name
+title: My Project Name
 logo: https://jstools.dev/img/logos/logo.png
 
 author:
- twitter: JSDevTools
+ twitter: MyTwitterAccount
 
 google_analytics: UA-68102273-3
 
 twitter:
- username: JSDevTools
+ username: MyTwitterAccount
 card: summary
 
 defaults:
diff --git a/bin/my-cli.js b/bin/my-cli.js
diff --git a/package.json b/package.json
@@ -1,22 +1,22 @@
{
- "name": "@jsdevtools/project-package-name",
+ "name": "@my-npm-scope/my-package-name",
 "version": "0.0.1",
- "description": "This is the project description",
+ "description": "The description of my library",
 "keywords": [],
 "author":{
 "name": "James Messinger",
 "url": "https://jamesmessinger.com"
 },
 "license": "MIT",
- "homepage": "https://jstools.dev/project-package-name",
+ "homepage": "https://jstools.dev/my-package-name",
 "repository":{
 "type": "git",
- "url": "https://github.com/JS-DevTools/project-package-name.git"
+ "url": "https://github.com/MyGitHubOrg/my-package-name.git"
 },
 "main": "lib/index.js",
 "types": "lib/index.d.ts",
 "bin":{
- "project-cli-name": "bin/project-cli-name.js"
+ "my-cli": "bin/my-cli.js"
 },
 "files": [
 "bin",
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -1,5 +1,5 @@
 // tslint:disable: no-console
-import{projectExportName } from "..";
+import{myLibrary } from "..";
 import{ExitCode } from "./exit-code";
 import{helpText } from "./help";
 import{manifest } from "./manifest";
@@ -30,7 +30,7 @@ export function main(args: string[]): void{
 process.exit(ExitCode.Success);
 }
 else{
- let result = projectExportName(options);
+ let result = myLibrary(options);
 
 if (!quiet){
 console.log(result);
diff --git a/src/index.ts b/src/index.ts
@@ -1,11 +1,11 @@
-import{projectExportName } from "./project-package-name";
+import{myLibrary } from "./my-package-name";
 
 export{Options } from "./settings";
-export{projectExportName };
+export{myLibrary };
 
-// Export `projectExportName` as the default export
+// Export `myLibrary` as the default export
 // tslint:disable: no-default-export
-export default projectExportName;
+export default myLibrary;
 
 // CommonJS default export hack
 if (typeof module === "object" && typeof module.exports === "object"){
diff --git a/src/my-package-name.ts b/src/my-package-name.ts
@@ -1,11 +1,11 @@
 import{Options, Settings } from "./settings";
 
 /**
- * This is the project description
+ * The description of my library
 *
 * @returns - Options
 */
-export function projectExportName(options?: Options): string{
+export function myLibrary(options?: Options): string{
 let settings = new Settings(options);
 
 if (settings.greeting === "Goodbye"){
diff --git a/test/specs/api.spec.js b/test/specs/api.spec.js
@@ -1,33 +1,33 @@
 "use strict";
 
-const projectExportName = require("../../");
+const myLibrary = require("../../");
 const{expect } = require("chai");
 
-describe("projectExportName() API", () =>{
+describe("myLibrary() API", () =>{
 
 it("should work without any arguments", () =>{
- let result = projectExportName();
+ let result = myLibrary();
 expect(result).to.equal("Hello, world.");
 });
 
 it("should accept a custom greeting", () =>{
- let result = projectExportName({greeting: "Hi there" });
+ let result = myLibrary({greeting: "Hi there" });
 expect(result).to.equal("Hi there, world.");
 });
 
 it("should accept a custom subject", () =>{
- let result = projectExportName({subject: "Michael" });
+ let result = myLibrary({subject: "Michael" });
 expect(result).to.equal("Hello, Michael.");
 });
 
 it("should accept a custom greeting and subject", () =>{
- let result = projectExportName({greeting: "Yo", subject: "man" });
+ let result = myLibrary({greeting: "Yo", subject: "man" });
 expect(result).to.equal("Yo, man.");
 });
 
 it('should not allow a greeting of "goodbye"', () =>{
 function sayGoodbye (){
- projectExportName({greeting: "Goodbye" });
+ myLibrary({greeting: "Goodbye" });
 }
 
 expect(sayGoodbye).to.throw("Cannot say goodbye");
diff --git a/test/specs/cli.spec.js b/test/specs/cli.spec.js
diff --git a/test/specs/exports.spec.js b/test/specs/exports.spec.js
diff --git a/test/utils/my-cli.js b/test/utils/my-cli.js

-Original file line number
+Diff line change
@@ @@ -1,5 +1,5 @@ @@
 // tslint:disable: no-console
 -import{projectExportName}from"..";
 +import{myLibrary}from"..";
 import{ExitCode}from"./exit-code";
 import{helpText}from"./help";
 import{manifest}from"./manifest";
 process.exit(ExitCode.Success);
+}
 else{
 -letresult=projectExportName(options);
 +letresult=myLibrary(options);
 if(!quiet){
 console.log(result);
-Original file line number
+Diff line change
@@ @@ -1,11 +1,11 @@ @@
 -import{projectExportName}from"./project-package-name";
 +import{myLibrary}from"./my-package-name";
 export{Options}from"./settings";
 -export{projectExportName};
 +export{myLibrary};
 -// Export `projectExportName` as the default export
 +// Export `myLibrary` as the default export
 // tslint:disable: no-default-export
 -exportdefaultprojectExportName;
 +exportdefaultmyLibrary;
 // CommonJS default export hack
 if(typeofmodule==="object"&&typeofmodule.exports==="object"){