mirror of https://github.com/foambubble/foam.git synced 2026-04-24 03:01:01 -04:00

Files

Riccardo 74dbf485df added support for graph middleware via local plugin (#261 )

* added support for graph middleware via local plugin

* added support for parsing extension points / plugins

* improved parser plugin and added docs

* improved name of parameter

* need to enable local plugins, and improved configuration system

For security reasons local plugins are off by default.
The feature can be enabled via a flag in the foam configuration, which has been expanded to support this case.
The configuration system now reads a `config.json` file inside the `.foam` directory as well as a `~/.foam/config.json` file to configure the system.
Only the user specific configuration file can be used to enable local plugins, as a security measure against malicious repos.

* added prettier configuration file

This ensures consistency across machines as well as an explicit source of truth

2020-10-07 22:19:04 +02:00

bin

Init new oclif project for foam-cli

2020-07-04 22:18:59 +01:00

src

added support for graph middleware via local plugin (#261 )

2020-10-07 22:19:04 +02:00

test

Implement janitor command to extension (#155 )

2020-07-25 17:17:03 +01:00

.editorconfig

Init new oclif project for foam-cli

2020-07-04 22:18:59 +01:00

.eslintignore

Init new oclif project for foam-cli

2020-07-04 22:18:59 +01:00

.eslintrc

Init new oclif project for foam-cli

2020-07-04 22:18:59 +01:00

.gitignore

Init new oclif project for foam-cli

2020-07-04 22:18:59 +01:00

babel.config.js

Implement foam-cli janitor command (#112 )

2020-07-20 19:28:41 +01:00

jest.config.js

Implement foam-cli janitor command (#112 )

2020-07-20 19:28:41 +01:00

package.json

Fix VSCode Launch Task and Monorepo builds (#193 )

2020-07-30 21:39:16 +01:00

README.md

v0.3.0

2020-07-25 18:28:52 +01:00

tsconfig.json

added support for graph middleware via local plugin (#261 )

2020-10-07 22:19:04 +02:00

README.md

foam-cli

Foam CLI

Usage
Commands

Usage

$ npm install -g foam-cli
$ foam COMMAND
running command...
$ foam (-v|--version|version)
foam-cli/0.3.0 darwin-x64 node-v12.18.0
$ foam --help [COMMAND]
USAGE
  $ foam COMMAND
...

Commands

foam help [COMMAND]
foam janitor [WORKSPACEPATH]
foam migrate [WORKSPACEPATH]

`foam help [COMMAND]`

display help for foam

USAGE
  $ foam help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`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-cli janitor path-to-foam-workspace

See code: src/commands/janitor.ts

`foam migrate [WORKSPACEPATH]`

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

USAGE
  $ foam migrate [WORKSPACEPATH]

OPTIONS
  -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: src/commands/migrate.ts

Development

Run yarn somewhere in workspace (ideally root, see yarn workspace docs
- This will automatically symlink all package directories so you're using the local copy
In packages/foam-core, run yarn start to rebuild the library on every change
In packages/foam-cli, make changes and run with yarn run cli. This should use latest workspace manager changes.