@anth0nycodes/license-generator 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,45 @@
1
+ ---
2
+ name: Bug Report
3
+ about: Report a bug or unexpected behavior
4
+ title: '[BUG] '
5
+ labels: bug
6
+ assignees: ''
7
+ ---
8
+
9
+ ## Description
10
+
11
+ <!-- A clear and concise description of the bug -->
12
+
13
+ ## Steps to Reproduce
14
+
15
+ 1.
16
+ 2.
17
+ 3.
18
+ 4.
19
+
20
+ ## Expected Behavior
21
+
22
+ <!-- What you expected to happen -->
23
+
24
+ ## Actual Behavior
25
+
26
+ <!-- What actually happened -->
27
+
28
+ ## Environment
29
+
30
+ - **OS:** <!-- e.g., macOS 14.0, Windows 11, Ubuntu 22.04 -->
31
+ - **Node.js version:** <!-- run `node --version` -->
32
+ - **Package version:** <!-- run `npm list -g @anth0nycodes/license-generator` -->
33
+ - **Installation method:** <!-- npm or pnpm -->
34
+
35
+ ## Error Output
36
+
37
+ <!-- If applicable, paste any error messages or screenshots -->
38
+
39
+ ```
40
+ Paste error output here
41
+ ```
42
+
43
+ ## Additional Context
44
+
45
+ <!-- Add any other context about the problem here -->
@@ -0,0 +1,41 @@
1
+ ---
2
+ name: Feature Request
3
+ about: Suggest a new feature or enhancement
4
+ title: '[FEATURE] '
5
+ labels: enhancement
6
+ assignees: ''
7
+ ---
8
+
9
+ ## Feature Description
10
+
11
+ <!-- A clear and concise description of the feature you'd like to see -->
12
+
13
+ ## Problem/Use Case
14
+
15
+ <!-- What problem does this solve? Why would this feature be useful? -->
16
+
17
+ ## Proposed Solution
18
+
19
+ <!-- How do you envision this feature working? -->
20
+
21
+ ## Alternative Solutions
22
+
23
+ <!-- Have you considered any alternative solutions or features? -->
24
+
25
+ ## Examples
26
+
27
+ <!-- If applicable, provide examples of how this feature would be used -->
28
+
29
+ ```bash
30
+ # Example usage
31
+ generate-license --some-new-flag
32
+ ```
33
+
34
+ ## Additional Context
35
+
36
+ <!-- Add any other context, screenshots, or references about the feature request -->
37
+
38
+ ## Would you like to contribute this feature?
39
+
40
+ - [ ] Yes, I'd like to work on this
41
+ - [ ] No, just suggesting
@@ -0,0 +1,46 @@
1
+ ## Description
2
+
3
+ <!-- Provide a brief description of the changes in this PR -->
4
+
5
+ ## Type of Change
6
+
7
+ <!-- Mark the relevant option with an "x" -->
8
+
9
+ - [ ] Bug fix (non-breaking change which fixes an issue)
10
+ - [ ] New feature (non-breaking change which adds functionality)
11
+ - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12
+ - [ ] Documentation update
13
+ - [ ] Refactoring (no functional changes)
14
+ - [ ] Other (please describe):
15
+
16
+ ## Related Issues
17
+
18
+ <!-- Link to related issues using #issue_number -->
19
+
20
+ Fixes #
21
+
22
+ ## Changes Made
23
+
24
+ <!-- List the specific changes made in this PR -->
25
+
26
+ -
27
+ -
28
+ -
29
+
30
+ ## Testing
31
+
32
+ <!-- Describe the testing you've done -->
33
+
34
+ - [ ] Tested locally with `pnpm dev`
35
+ - [ ] Tested built version with `pnpm build && pnpm start`
36
+ - [ ] Tested as installed package with `pnpm link`
37
+ - [ ] Tested with different license types
38
+ - [ ] Tested edge cases (existing LICENSE file, etc.)
39
+
40
+ ## Checklist
41
+
42
+ - [ ] My code follows the project's coding style
43
+ - [ ] I have performed a self-review of my own code
44
+ - [ ] I have commented my code where necessary
45
+ - [ ] My changes generate no new warnings or errors
46
+ - [ ] I have updated the documentation (if applicable)
@@ -0,0 +1,11 @@
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5
+
6
+ version: 2
7
+ updates:
8
+ - package-ecosystem: "npm"
9
+ directory: "/"
10
+ schedule:
11
+ interval: "weekly"
@@ -0,0 +1,126 @@
1
+ # Contributing to License Generator
2
+
3
+ Thank you for your interest in contributing to License Generator! This document provides guidelines and instructions for contributing.
4
+
5
+ ## Code of Conduct
6
+
7
+ Please be respectful and considerate in your interactions with other contributors.
8
+
9
+ ## Getting Started
10
+
11
+ ### Prerequisites
12
+
13
+ - Node.js 20.x or higher
14
+ - pnpm (recommended) or npm
15
+
16
+ ### Setting Up Your Development Environment
17
+
18
+ 1. Fork the repository on GitHub
19
+ 2. Clone your fork locally:
20
+ ```bash
21
+ git clone https://github.com/YOUR_USERNAME/license-generator.git
22
+ cd license-generator
23
+ ```
24
+
25
+ 3. Install dependencies:
26
+ ```bash
27
+ pnpm install
28
+ ```
29
+
30
+ 4. Create a new branch for your feature or bug fix:
31
+ ```bash
32
+ git checkout -b feature/your-feature-name
33
+ ```
34
+
35
+ ## Development Workflow
36
+
37
+ ### Running the Project Locally
38
+
39
+ ```bash
40
+ # Run in development mode with hot reload
41
+ pnpm dev
42
+
43
+ # Build the project
44
+ pnpm build
45
+
46
+ # Run the built version
47
+ pnpm start
48
+
49
+ # Test as an installed package
50
+ pnpm link
51
+ generate-license
52
+ ```
53
+
54
+ ### Making Changes
55
+
56
+ 1. Make your changes in your feature branch
57
+ 2. Test your changes thoroughly:
58
+ - Run `pnpm dev` and test interactively
59
+ - Test with different license types
60
+ - Test edge cases (existing LICENSE file, etc.)
61
+ 3. Ensure your code follows the existing style
62
+ 4. Update documentation if needed
63
+
64
+ ## Submitting Changes
65
+
66
+ ### Pull Request Process
67
+
68
+ 1. Commit your changes with clear, descriptive commit messages:
69
+ ```bash
70
+ git commit -m "Add feature: description of your changes"
71
+ ```
72
+
73
+ 2. Push to your fork:
74
+ ```bash
75
+ git push origin feature/your-feature-name
76
+ ```
77
+
78
+ 3. Open a Pull Request on GitHub:
79
+ - Fill out the PR template completely
80
+ - Link any related issues
81
+ - Describe what you changed and why
82
+ - Include screenshots or examples if applicable
83
+
84
+ 4. Wait for review:
85
+ - Address any feedback from maintainers
86
+ - Make requested changes if needed
87
+ - Keep your PR updated with the main branch
88
+
89
+ ### Commit Message Guidelines
90
+
91
+ - Use the present tense ("Add feature" not "Added feature")
92
+ - Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
93
+ - Keep the first line under 72 characters
94
+ - Reference issues and pull requests where appropriate
95
+
96
+ ## Reporting Bugs
97
+
98
+ If you find a bug, please create an issue using the bug report template. Include:
99
+
100
+ - A clear description of the bug
101
+ - Steps to reproduce the issue
102
+ - Expected vs actual behavior
103
+ - Your environment (OS, Node.js version, package version)
104
+ - Error messages or screenshots
105
+
106
+ ## Suggesting Features
107
+
108
+ We welcome feature suggestions! Please create an issue using the feature request template. Include:
109
+
110
+ - A clear description of the feature
111
+ - The problem it solves or use case
112
+ - How you envision it working
113
+ - Any examples or references
114
+
115
+ ## Questions?
116
+
117
+ If you have questions about contributing, feel free to:
118
+
119
+ - Open an issue with your question
120
+ - Check existing issues and discussions
121
+
122
+ ## License
123
+
124
+ By contributing to License Generator, you agree that your contributions will be licensed under the same license as the project (MIT License).
125
+
126
+ Thank you for contributing!
package/README.md CHANGED
@@ -2,6 +2,11 @@
2
2
 
3
3
  An interactive CLI tool to quickly generate open-source licenses for your projects.
4
4
 
5
+ ## Demo
6
+
7
+ <video src="https://github.com/user-attachments/assets/25d4a68b-4cb3-4570-ac57-88d955bbcb53" style="width: 100%;" controls playsinline>
8
+ </video>
9
+
5
10
  ## Features
6
11
 
7
12
  - 🚀 Interactive license selection from GitHub's license API
@@ -12,7 +17,7 @@ An interactive CLI tool to quickly generate open-source licenses for your projec
12
17
  ## Installation
13
18
 
14
19
  ```bash
15
- pnpm install -g @anth0nycodes/license-generator
20
+ pnpm add -g @anth0nycodes/license-generator
16
21
  ```
17
22
 
18
23
  Or using npm:
@@ -80,6 +85,8 @@ pnpm start
80
85
 
81
86
  Contributions are welcome! Please feel free to submit a Pull Request.
82
87
 
88
+ For detailed guidelines on how to contribute, please see our [Contributing Guide](CONTRIBUTING.md).
89
+
83
90
  ## Author
84
91
 
85
92
  **Anthony Hoang**
package/dist/index.js CHANGED
@@ -9,7 +9,10 @@ const main = async () => {
9
9
  program
10
10
  .name("License Generator")
11
11
  .description("A CLI application that generates open-source licenses for your repositories.")
12
- .version("0.1.0");
12
+ .option("-l, --license <TYPE>", "the type of license")
13
+ .option("-a, --author <NAME>", "author's name")
14
+ .option("-y, --year <NAME>", "current year")
15
+ .version("0.2.0");
13
16
  // TODO: Add options, so you can manually add a license flag like --license mit
14
17
  program.parse();
15
18
  intro(color.blueBright("License Generator"));
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;IACtB,OAAO;SACJ,IAAI,CAAC,mBAAmB,CAAC;SACzB,WAAW,CACV,8EAA8E,CAC/E;SACA,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB,+EAA+E;IAE/E,OAAO,CAAC,KAAK,EAAE,CAAC;IAEhB,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,iCAAiC,CAAC;IACnD,MAAM,QAAQ,GAAG,MAAM,WAAW,EAAE,CAAC;IAErC,8CAA8C;IAC9C,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC;QACjC,OAAO,EAAE,mBAAmB;QAC5B,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAClC,KAAK,EAAE,OAAO,CAAC,GAAG;YAClB,KAAK,EAAE,OAAO,CAAC,IAAI;SACpB,CAAC,CAAC;KACJ,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5B,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,oCAAoC;IACpC,IAAI,OAAuC,CAAC;IAE5C,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;YAC9B;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,aAAa;gBACtB,OAAO,EAAE,cAAc,EAAE;gBACzB,QAAQ,CAAC,KAAK;oBACZ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,OAAO,kBAAkB,CAAC;oBAClD,OAAO,IAAI,CAAC;gBACd,CAAC;aACF;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,aAAa;gBACtB,OAAO,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;gBACzC,QAAQ,CAAC,KAAK;oBACZ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,OAAO,kBAAkB,CAAC;oBAClD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;wBAAE,OAAO,4BAA4B,CAAC;oBAChE,OAAO,IAAI,CAAC;gBACd,CAAC;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,2CAA2C;IAC3C,MAAM,oBAAoB,GAAG,MAAM,iBAAiB,CAClD,GAAG,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,EAAE,CACvC,CAAC;IAEF,qBAAqB;IACrB,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,oBAAoB,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAC;QAC3D,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,IAAI,CAAC;IACH,IAAI,EAAE,CAAC;AACT,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAC;AAC3C,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;IACtB,OAAO;SACJ,IAAI,CAAC,mBAAmB,CAAC;SACzB,WAAW,CACV,8EAA8E,CAC/E;SACA,MAAM,CAAC,sBAAsB,EAAE,qBAAqB,CAAC;SACrD,MAAM,CAAC,qBAAqB,EAAE,eAAe,CAAC;SAC9C,MAAM,CAAC,mBAAmB,EAAE,cAAc,CAAC;SAC3C,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB,+EAA+E;IAE/E,OAAO,CAAC,KAAK,EAAE,CAAC;IAEhB,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,iCAAiC,CAAC;IACnD,MAAM,QAAQ,GAAG,MAAM,WAAW,EAAE,CAAC;IAErC,8CAA8C;IAC9C,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC;QACjC,OAAO,EAAE,mBAAmB;QAC5B,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAClC,KAAK,EAAE,OAAO,CAAC,GAAG;YAClB,KAAK,EAAE,OAAO,CAAC,IAAI;SACpB,CAAC,CAAC;KACJ,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5B,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,oCAAoC;IACpC,IAAI,OAAuC,CAAC;IAE5C,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;YAC9B;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,aAAa;gBACtB,OAAO,EAAE,cAAc,EAAE;gBACzB,QAAQ,CAAC,KAAK;oBACZ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,OAAO,kBAAkB,CAAC;oBAClD,OAAO,IAAI,CAAC;gBACd,CAAC;aACF;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,aAAa;gBACtB,OAAO,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;gBACzC,QAAQ,CAAC,KAAK;oBACZ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,OAAO,kBAAkB,CAAC;oBAClD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;wBAAE,OAAO,4BAA4B,CAAC;oBAChE,OAAO,IAAI,CAAC;gBACd,CAAC;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,2CAA2C;IAC3C,MAAM,oBAAoB,GAAG,MAAM,iBAAiB,CAClD,GAAG,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,EAAE,CACvC,CAAC;IAEF,qBAAqB;IACrB,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,oBAAoB,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAC;QAC3D,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,IAAI,CAAC;IACH,IAAI,EAAE,CAAC;AACT,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAC;AAC3C,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@anth0nycodes/license-generator",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "An open-source CLI tool to generate licenses for your repository.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -24,7 +24,7 @@
24
24
  "scaffold"
25
25
  ],
26
26
  "author": "Anthony Hoang",
27
- "license": "ISC",
27
+ "license": "MIT",
28
28
  "repository": {
29
29
  "type": "git",
30
30
  "url": "git+https://github.com/anth0nycodes/license-generator.git"
package/src/index.ts CHANGED
@@ -13,7 +13,10 @@ const main = async () => {
13
13
  .description(
14
14
  "A CLI application that generates open-source licenses for your repositories.",
15
15
  )
16
- .version("0.1.0");
16
+ .option("-l, --license <TYPE>", "the type of license")
17
+ .option("-a, --author <NAME>", "author's name")
18
+ .option("-y, --year <NAME>", "current year")
19
+ .version("0.2.0");
17
20
 
18
21
  // TODO: Add options, so you can manually add a license flag like --license mit
19
22
 
package/todo.md ADDED
@@ -0,0 +1,6 @@
1
+ - Learn more about dependabot
2
+ - Learn more about major/minor/patch updates
3
+ - Learn about maintaining npm packages
4
+ - Research @changesets/cli
5
+
6
+ - Add options and then try to pass their values by getting options from program.options() into the main program inputs, refactor code structure if needed