diff --git a/README.md b/README.md
index eb8eb05..14eeaff 100644
--- a/README.md
+++ b/README.md
@@ -25,11 +25,13 @@
+
+
## Installation
-Make sure `yeoman` is installed:
+Make sure `yeoman` is installed
```sh
$ yarn global add yo
@@ -43,22 +45,26 @@ $ yarn global add generator-create-package
## Usage
-With [yo](https://github.com/yeoman/yo):
+Create a new directory
+
+```sh
+$ mkdir package-name
+```
+
+Then navigate to the created directory and run the following command to generate source
```sh
$ yo create-package
```
This scaffolds out:
+
```
-├── CHANGELOG.md
-├── README.md
-├── package.json
-├── rollup.config.js
├── src
│ ├── index.ts
-│ └── package-name
-│ └── index.ts
+├── .huskyrc
+├── package.json
+├── rollup.config.js
├── tsconfig.json
└── tslint.json
```
diff --git a/banner.png b/banner.png
new file mode 100644
index 0000000..cc2a9ac
Binary files /dev/null and b/banner.png differ
diff --git a/generators/app/index.js b/generators/app/index.js
index c991358..c4f70a8 100644
--- a/generators/app/index.js
+++ b/generators/app/index.js
@@ -10,24 +10,53 @@ module.exports = class extends Generator {
yosay(`Welcome to the astounding ${chalk.red(pkg.name)} generator!`),
);
+ const gitName = this.user.git.name() || 'organization';
+ const gitEmail = this.user.git.email() || 'hi@domain.com';
+ const githubUsername = await (async () => {
+ try {
+ const username = await this.user.github.username();
+
+ return username;
+ } catch (err) {
+ return 'organization';
+ }
+ })();
const prompts = [
{
type: 'input',
name: 'elementName',
message: 'What is the name of your package?',
- default: 'my-awesome-package',
+ default: this.appname,
},
{
type: 'input',
name: 'elementDescription',
- message: 'Give us some small description of your package',
- default: '',
+ message: 'Description of your package?',
+ default: 'My awesome package',
+ },
+ {
+ type: 'input',
+ name: 'elementHomepageUrl',
+ message: 'Package homepage URL?',
+ default: `https://github.com/${githubUsername}/${this.appname}`,
+ },
+ {
+ type: 'input',
+ name: 'elementBugsUrl',
+ message: 'Bugs tracking site?',
+ default: `https://github.com/${githubUsername}/${this.appname}/issues`,
},
{
type: 'input',
name: 'elementAuthor',
- message: 'Who is the author of this package?',
- default: '',
+ message: 'Author of this package?',
+ default: `${gitName} \<${gitEmail}\>`,
+ },
+ {
+ type: 'input',
+ name: 'elementRepositoryUrl',
+ message: 'Package repository URL?',
+ default: `https://github.com/${githubUsername}/${this.appname}.git`,
},
];
@@ -39,13 +68,13 @@ module.exports = class extends Generator {
writing() {
this.fs.copyTpl(
- [this.templatePath('**')],
+ [this.templatePath('**/*.*')],
this.destinationPath(),
this.props,
);
}
install() {
- this.installDependencies();
+ this.yarnInstall();
}
};
diff --git a/generators/app/templates/.gitignore b/generators/app/templates/.gitignore
deleted file mode 100644
index 12e6db6..0000000
--- a/generators/app/templates/.gitignore
+++ /dev/null
@@ -1,5 +0,0 @@
-.DS_Store
-node_modules
-.env
-.tmp
-.rpt2_cache
diff --git a/generators/app/templates/README.md b/generators/app/templates/README.md
deleted file mode 100644
index a5ba384..0000000
--- a/generators/app/templates/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# <%= elementName %>
-
-Library Starter Kit
diff --git a/generators/app/templates/package.json b/generators/app/templates/package.json
index a92cef3..fb4d330 100644
--- a/generators/app/templates/package.json
+++ b/generators/app/templates/package.json
@@ -1,12 +1,11 @@
{
"name": "<%= elementName %>",
- "description": "<%= elementDescription %>",
"version": "0.0.0",
- "private": true,
- "license": "MIT",
- "author": "<%= elementAuthor %>",
- "repository": "",
- "bugs": "",
+ "description": "<%= elementDescription %>",
+ "homepage": "<%= elementHomepageUrl %>",
+ "bugs": "<%= elementBugsUrl %>",
+ "author": "<%- elementAuthor %>",
+ "repository": "<%= elementRepositoryUrl %>",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"files": [
@@ -25,7 +24,6 @@
"release:patch": "yarn release --release-as patch"
},
"devDependencies": {
- "@types/isomorphic-fetch": "^0.0.35",
"husky": "^2.3.0",
"rollup": "^1.12.3",
"rollup-plugin-async": "^1.2.0",
diff --git a/generators/app/templates/src/index.ts b/generators/app/templates/src/index.ts
index cc919e8..ff8b4c5 100644
--- a/generators/app/templates/src/index.ts
+++ b/generators/app/templates/src/index.ts
@@ -1 +1 @@
-export * from './package-name';
+export default {};
diff --git a/generators/app/templates/src/package-name/index.ts b/generators/app/templates/src/package-name/index.ts
deleted file mode 100644
index cb0ff5c..0000000
--- a/generators/app/templates/src/package-name/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export {};