cezaraugusto / mklicense

CLI tool for generating Licenses. Easily.

mklicense

CLI tool for generating Licenses. Easily.

Stay Tuned ⭐ ⭐ ⭐ ⭐ ⭐

v. 1.0 is coming!

• mklicense will behave like an old school text-based game, to drive you to which license suits best for your project (thanks Jerod Santo for the idea). But still keeping its value as-is, behaving like a straight-to-the-point tool.

Why should I use this?

• Licenses are boring;
• Copy/paste stuff is so 1999;
• The GitHub LICENSE generator doesn't necessarily includes your information inside the file;
• It's busy people/beginner's friendly. It doesn't have all those flags to just install a license;
• You shouldn't trust other people to store your LICENSE sources. LICENSEs are sensible.

Install

$ npm install -g mklicense

Usage

$ mklicense

Since its version 0.1.4, mklicense needs Node version >=4 to run properly.

Licenses included

• Unlicense
• MIT
• Apache 2.0
• MPL 2.0
• GNU LGPL 3.0
• GNU GPL 3.0
• GNU AGPL 3.0

You talk about trust. So, where are all the licenses located?

mklicense extracts licenses from http://choosealicense.com/ (which is curated by GitHub), and creates a .txt file for your desired project. I have no control over any license, which is a good thing for you and me.

License

MIT © Cezar Augusto

mklicense's Issues

Couldn't generate project's beginning year and author name in Apache 2.0

Issues

I tried to generate Apache 2.0 License. The mklicense asked me for the project's beginning year and author. However, there's not this information in the generated file.

Environment

• MacOS Ventura 13.0（22A380)
• node v19.2.0
• when a license is generated

Current Output

LICENSE 185〜193

...
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
...

Expected Output

LICENSE 185〜193

...
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright 2023 Mutsuha Asada

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
...

While describing an issue, check if:

• You described which Operational System you're using
• You described which Node version (node -v) you're using
• At which point of the program you found the issue

A bit more help choosing which license?

Licensing is scary - it would be cool to have a series of questions that lead the user down a flowchart to the right license to use for a project. Or maybe just a really neutral summary of each on the selection screen, similar to http://choosealicense.com/

Freezes on Windows, Node.js >=v10.2

On Windows environment and Node >=v10.2,
it freezes after the message generating license.

• Does Not Work on
  • Windows 8.1 Pro (x64)
    • Node.js: >=v10.2.0 (Checked as NG on v10.2.0, v10.2.1, v10.5.0, v10.9.0, v10.10.0, v10.15.3, v12.3.1)
• Works on
  • Windows 8.1 Pro (x64)
    • Node.js: <v10.2.0 (Checked as OK on v10.1.0, v10.0.0, v9.11.2, v8.16.0)
  • Ubuntu 14.04.6 LTS (x64)
    • Node.js: ANY (Checked as OK on v10.15.3, v8.16.0)

It looks jsdom.env() is not responding.

While it is working on Ubuntu,
some change at Node.js v10.2 would have made something wrong on jsdom, just on Windows.

It would be jsdom's problem, probably,
but it would have better rewrite the jsdom.env() call
while jsdom.env() has gone until jsdom latest v15.1.0.

GPL v3 generation

The program asks user about these parameters:

1. year of licensing;
2. full name;
3. project name and one-line description.

However, neither of these values is used in generated text:

$ md5sum LICENSE
1ebbd3e34237af26da5dc08a4e440464

There is following lines in the generated text:

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

But they are just an example of what should be pasted into changed files.

If I understand correctly, asking user for these parameters is excessive without putting them anywhere.