Skip to content

Commit

Permalink
v0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jevakallio committed Jul 25, 2020
1 parent 50dd368 commit 5418ea8
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 23 deletions.
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "0.2.0"
"version": "0.3.0"
}
56 changes: 37 additions & 19 deletions packages/foam-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $ npm install -g foam-cli
$ foam COMMAND
running command...
$ foam (-v|--version|version)
foam-cli/0.2.0 darwin-x64 node-v12.18.0
foam-cli/0.3.0 darwin-x64 node-v12.18.0
$ foam --help [COMMAND]
USAGE
$ foam COMMAND
Expand All @@ -28,45 +28,63 @@ USAGE
<!-- usagestop -->
# Commands
<!-- commands -->
* [`foam hello [FILE]`](#foam-hello-file)
* [`foam help [COMMAND]`](#foam-help-command)
* [`foam janitor [WORKSPACEPATH]`](#foam-janitor-workspacepath)
* [`foam migrate [WORKSPACEPATH]`](#foam-migrate-workspacepath)

## `foam hello [FILE]`
## `foam help [COMMAND]`

describe the command here
display help for foam

```
USAGE
$ foam hello [FILE]
$ foam help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_

## `foam janitor [WORKSPACEPATH]`

Updates link references and heading across all the markdown files in the given workspaces

```
USAGE
$ foam janitor [WORKSPACEPATH]
OPTIONS
-h, --help show CLI help
-w, --without-extensions generate link reference definitions without extensions (for legacy support)
EXAMPLE
$ foam hello
hello world from ./src/hello.ts!
$ foam-cli janitor path-to-foam-workspace
```

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

## `foam help [COMMAND]`
## `foam migrate [WORKSPACEPATH]`

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

```
USAGE
$ foam help [COMMAND]
ARGUMENTS
COMMAND command to show help for
$ foam migrate [WORKSPACEPATH]
OPTIONS
--all see all commands in CLI
-h, --help show CLI help
-w, --without-extensions generate link reference definitions without extensions (for legacy support)
EXAMPLE
$ foam-cli migrate path-to-foam-workspace
Successfully generated link references and heading!
```

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

## Development
Expand Down
2 changes: 1 addition & 1 deletion packages/foam-cli/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "foam-cli",
"description": "Foam CLI",
"version": "0.2.0",
"version": "0.3.0",
"author": "Jani Eväkallio @jevakallio",
"bin": {
"foam": "./bin/run"
Expand Down
2 changes: 1 addition & 1 deletion packages/foam-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "foam-core",
"author": "Jani Eväkallio",
"repository": "https://github.com/foambubble/foam",
"version": "0.2.0",
"version": "0.3.0",
"license": "MIT",
"files": [
"dist"
Expand Down
2 changes: 1 addition & 1 deletion packages/foam-vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Generate markdown reference lists from wikilinks in a workspace",
"author": "Jani Eväkallio",
"repository": "https://github.com/foambubble/foam",
"version": "0.2.0",
"version": "0.3.0",
"license": "MIT",
"publisher": "foam",
"engines": {
Expand Down

0 comments on commit 5418ea8

Please sign in to comment.