https://github.com/bpevs/johnny_decimal

Utilities for interacting with a Johnny Decimal filing system.
https://github.com/bpevs/johnny_decimal

cli deno johnny-decimal typescript

Last synced: 3 months ago
JSON representation

Utilities for interacting with a Johnny Decimal filing system.

• Host: GitHub
• URL: https://github.com/bpevs/johnny_decimal
• Owner: bpevs
• License: other
• Created: 2022-02-28T04:02:26.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-18T17:38:02.000Z (12 months ago)
• Last Synced: 2024-10-28T12:16:39.051Z (3 months ago)
• Topics: cli, deno, johnny-decimal, typescript
• Language: TypeScript
• Homepage: https://johnny.bpev.me
• Size: 1.54 MB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Johnny Decimal

Importable utilities built with Typescript, for interacting with a

[Johnny Decimal](https://johnnydecimal.com/) filing system.

This document is geared for using our modules for your own Johnny Decimal

javascript applications. **For CLI usage and Plugin Development information, use

our [CLI guide](https://johnny.bpev.me)**

## API Documentation

Mostly, the code comments should be sufficient; these are used to generate our

[Deno Docs](https://doc.deno.land/https/deno.land/x/johnny_decimal/mod.ts)

## Getting Started

You can import the utilities used in the CLI from deno.land:

```js

import {

  // Directory and Location are Deno-specific imports are good for fs usecases

  Directory,

  DirectoryCore,

  // Commands exported from johnny_decimal are all Deno-specific.

  // These are the apis used for the Johnny Decimal CLI

  helpCommand,

  Location,

  // LocationCore and DirectoryCore are much more bare, but are pure javascript.

  // Better when aiming to compile for web

  LocationCore,

} from "https://deno.land/x/johnny_decimal/mod.ts";

const directory = new Directory({

  $HOME: $HOME,

  $JD_HOME: $JD_HOME,

  $JD_DIR: $JD_DIR,

});

// DirectoryCore still includes command-management functionality.

directory.registerCommand(defaultCommand);

// LocationCore still includes lots of utility functions

console.log(LocationCore.isAreaId("21.04")); // false

directory.runCommand("default", []);

```