-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): add docs for copyright generator
- Loading branch information
1 parent
b0d66e5
commit 65c62e1
Showing
6 changed files
with
97 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
lang: en | ||
title: 'Generate copyright/license header for JavaScript/TypeScript files' | ||
keywords: LoopBack 4.0, LoopBack 4 | ||
sidebar: lb4_sidebar | ||
permalink: /doc/en/lb4/Copyright-generator.html | ||
--- | ||
|
||
### Synopsis | ||
|
||
The `lb4 copyright` command runs inside a Node.js project with `package.json` to | ||
add or update copyright/license header for JavaScript and TypeScript files based | ||
on `package.json` and git history. | ||
|
||
The command also supports [lerna](https://github.com/lerna/lerna) monorepos. It | ||
traverses all packages within the monorepo and apply copyright/license headers. | ||
|
||
```sh | ||
lb4 copyright [options] | ||
``` | ||
|
||
The following is an example of such headers. | ||
|
||
```js | ||
// Copyright IBM Corp. 2020. All Rights Reserved. | ||
// Node module: @loopback/cli | ||
// This file is licensed under the MIT License. | ||
// License text available at https://opensource.org/licenses/MIT | ||
``` | ||
|
||
The year(s) is built from the git history of the file and `Node module` is read | ||
from the `name` property in `package.json`. | ||
|
||
Please note the command expects `git` is installed. | ||
|
||
### Options | ||
|
||
`--owner` : _(Optional)_ The owner of the copyright, such as `IBM Corp.`. | ||
|
||
`--license` : _(Optional)_ The name of the license, such as `MIT`. | ||
|
||
`--gitOnly` : _(Optional)_ A flag to control if only git tracked files are | ||
updated. Default to `true`. | ||
|
||
### Interactive Prompts | ||
|
||
The command prompts you for: | ||
|
||
1. The copyright owner. The default value is read from `copyright.owner` or | ||
`author` in the `package.json`. | ||
|
||
2. The license name. The default value is read from `license` in the | ||
`package.json`. | ||
|
||
The default owner is `IBM Corp.` and license is `MIT` with the following | ||
`package.json`. | ||
|
||
```json | ||
{ | ||
"name": "@loopback/boot", | ||
"version": "2.0.2", | ||
"author": "IBM Corp.", | ||
"copyright.owner": "IBM Corp.", | ||
"license": "MIT" | ||
} | ||
``` | ||
|
||
### Output | ||
|
||
The following output is captured when `lb4 copyright` is run against | ||
[`loopback4-example-shopping`](https://github.com/strongloop/loopback4-example-shopping). | ||
|
||
``` | ||
? Copyright owner: IBM Corp. | ||
? License name: MIT | ||
Updating project loopback4-example-recommender (packages/recommender) | ||
Updating project loopback4-example-shopping (packages/shopping) | ||
Updating project loopback4-example-shopping-monorepo (.) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters