Skip to content

Commit 5418ea8

Browse files
committed
v0.3.0
1 parent 50dd368 commit 5418ea8

File tree

5 files changed

+41
-23
lines changed

5 files changed

+41
-23
lines changed

lerna.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
],
55
"npmClient": "yarn",
66
"useWorkspaces": true,
7-
"version": "0.2.0"
7+
"version": "0.3.0"
88
}

packages/foam-cli/README.md

+37-19
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ $ npm install -g foam-cli
1919
$ foam COMMAND
2020
running command...
2121
$ foam (-v|--version|version)
22-
foam-cli/0.2.0 darwin-x64 node-v12.18.0
22+
foam-cli/0.3.0 darwin-x64 node-v12.18.0
2323
$ foam --help [COMMAND]
2424
USAGE
2525
$ foam COMMAND
@@ -28,45 +28,63 @@ USAGE
2828
<!-- usagestop -->
2929
# Commands
3030
<!-- commands -->
31-
* [`foam hello [FILE]`](#foam-hello-file)
3231
* [`foam help [COMMAND]`](#foam-help-command)
32+
* [`foam janitor [WORKSPACEPATH]`](#foam-janitor-workspacepath)
33+
* [`foam migrate [WORKSPACEPATH]`](#foam-migrate-workspacepath)
3334

34-
## `foam hello [FILE]`
35+
## `foam help [COMMAND]`
3536

36-
describe the command here
37+
display help for foam
3738

3839
```
3940
USAGE
40-
$ foam hello [FILE]
41+
$ foam help [COMMAND]
42+
43+
ARGUMENTS
44+
COMMAND command to show help for
4145
4246
OPTIONS
43-
-f, --force
44-
-h, --help show CLI help
45-
-n, --name=name name to print
47+
--all see all commands in CLI
48+
```
49+
50+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
51+
52+
## `foam janitor [WORKSPACEPATH]`
53+
54+
Updates link references and heading across all the markdown files in the given workspaces
55+
56+
```
57+
USAGE
58+
$ foam janitor [WORKSPACEPATH]
59+
60+
OPTIONS
61+
-h, --help show CLI help
62+
-w, --without-extensions generate link reference definitions without extensions (for legacy support)
4663
4764
EXAMPLE
48-
$ foam hello
49-
hello world from ./src/hello.ts!
65+
$ foam-cli janitor path-to-foam-workspace
5066
```
5167

52-
_See code: [src/commands/hello.ts](https://github.com/foambubble/foam/blob/v0.2.0/src/commands/hello.ts)_
68+
_See code: [src/commands/janitor.ts](https://github.com/foambubble/foam/blob/v0.3.0/src/commands/janitor.ts)_
5369

54-
## `foam help [COMMAND]`
70+
## `foam migrate [WORKSPACEPATH]`
5571

56-
display help for foam
72+
Updates file names, link references and heading across all the markdown files in the given workspaces
5773

5874
```
5975
USAGE
60-
$ foam help [COMMAND]
61-
62-
ARGUMENTS
63-
COMMAND command to show help for
76+
$ foam migrate [WORKSPACEPATH]
6477
6578
OPTIONS
66-
--all see all commands in CLI
79+
-h, --help show CLI help
80+
-w, --without-extensions generate link reference definitions without extensions (for legacy support)
81+
82+
EXAMPLE
83+
$ foam-cli migrate path-to-foam-workspace
84+
Successfully generated link references and heading!
6785
```
6886

69-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
87+
_See code: [src/commands/migrate.ts](https://github.com/foambubble/foam/blob/v0.3.0/src/commands/migrate.ts)_
7088
<!-- commandsstop -->
7189

7290
## Development

packages/foam-cli/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "foam-cli",
33
"description": "Foam CLI",
4-
"version": "0.2.0",
4+
"version": "0.3.0",
55
"author": "Jani Eväkallio @jevakallio",
66
"bin": {
77
"foam": "./bin/run"

packages/foam-core/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "foam-core",
33
"author": "Jani Eväkallio",
44
"repository": "https://github.com/foambubble/foam",
5-
"version": "0.2.0",
5+
"version": "0.3.0",
66
"license": "MIT",
77
"files": [
88
"dist"

packages/foam-vscode/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "Generate markdown reference lists from wikilinks in a workspace",
55
"author": "Jani Eväkallio",
66
"repository": "https://github.com/foambubble/foam",
7-
"version": "0.2.0",
7+
"version": "0.3.0",
88
"license": "MIT",
99
"publisher": "foam",
1010
"engines": {

0 commit comments

Comments
 (0)