GithubHelp home page GithubHelp logo

breck7 / jtree Goto Github PK

View Code? Open in Web Editor NEW
372.0 10.0 16.0 74.46 MB

Build your own language using Tree Notation.

Home Page: http://jtree.treenotation.org

JavaScript 74.13% HTML 0.31% CSS 0.44% TypeScript 25.13%

jtree's Introduction

import header.scroll
permalink index.html
title JTree: Tree Notation SDK for TypeScript & Javascript
startColumns 4
import ciBadges.scroll

# Links
Tree Notation Homepage
 https://treenotation.org
Tree Notation Sandbox
 https://jtree.treenotation.org/sandbox
Tree Language Designer
 https://jtree.treenotation.org/designer
Release Notes
 https://jtree.treenotation.org/releaseNotes.html
Tree Notation FAQ
 https://faq.treenotation.org
TrueBase
 https://truebase.pub/
TypeScript Library
 https://github.com/treenotation/jtree
Tree Notation Subreddit
 https://reddit.com/r/treenotation
Ohayo - A data science studio powered by Tree Notation
 https://github.com/treenotation/ohayo
UnitTests
 https://jtree.treenotation.org/sandbox/test.html
PerfTests
 https://jtree.treenotation.org/sandbox/perfTests.html

? Who is this package built for?
Jtree is for people who want to design Tree Languages, make Tree editing tools, or use the Tree Component Web Framework.
You can think of jtree as similar to the Java Development Kit, except for Tree Notation instead of Java.

? How do I build a new language?
You can try the Grammar tutorial.
 link grammarTutorial.html Grammar tutorial

# Grammar Files
Jtree contains a Tree Language called "Grammar". You can write new Grammar files to define new languages. By creating a grammar file you get a parser, a type checker, syntax highlighting, autocomplete, a compiler, and virtual machine for executing your new language. Jtree also includes a simple web Tree Language Designer.
 https://jtree.treenotation.org/designer Designer

To make your language do really interesting things, you'll want to write some code to extend your language nodes in another language that you know. Jtree lets you create new languages using just Tree Notation, Tree Notation + TypeScript, or Tree Notation + Javascript. Tree Notation and Tree Languages can be built with any language, however, not just TypeScript and Javascript. We are looking for volunteers to build libraries/sdks in other host languages.

# Using Jtree

## Quick start
- Open https://gitpod.io/#https://github.com/breck7/jtree
- Run:
code
 npm install -g ts-node
 npm install .
 npm run test

Jtree currently includes over 10 compiled projects (aka "products") and more than a dozen Tree Languages.

# Basic TreeNode library for npm projects:
code
 const {TreeNode} = require("jtree/products/TreeNode.js")
 const tree = new TreeNode("hello world")
 console.log(tree.asString)

# Basic TreeNode library + Grammar Language for the browser:
code
 <script src="../../products/Utils.browser.js"></script>
 <script src="../../products/TreeNode.browser.js"></script>
 <script src="../../products/GrammarLanguage.browser.js"></script>

## jtree "sandbox" web app for exploring base Tree Notation
code
 npm install .
 npm run local
 open http://localhost:3333/

## jtree "Designer" web app for building new Tree Languages
code
 npm install .
 npm run local
 open http://localhost:3333/designer

## TreeComponentFramework for building web apps
This is a web framework still in the research stage. Whether it evolves into a serious line of effort is unknown.

## Sample Languages
More than 12 example Tree Languages for helping with various tasks. See the `langs/` folder.

##  Build Tools
If you look at the source, you will also see a set of build tools (such as Builder and TypeScriptRewriter). These are currently undocumented and not recommended for external use.

## Building all tools and running tests
code
 npm run build
 npm test

# Monorepo
Jtree is a monorepo. With on average over 1 major version released each month for the past 2.5 years, it would take a lot of overhead to constantly be updating 10+ different repositories and modules every month. Once we're more confident in the theory and best practices, it might make sense to break this repo into independent modules.
That being said, we despise unnecessary dependencies as much as anyone. If anyone wants to create some automated submodules built from the projects in this monorepo, to allow for consuming of a smaller subset of the code and dependencies in this module, feel free to do so.

## Visualization of the code base
 https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=breck7%2Fjtree Visualization
image images/diagram.svg

# Development Status
All breaking changes are mentioned in the releaseNotes. We follow semantic versioning, so breaking changes should not happen if you stay on the same major version.
 link releaseNotes.html releaseNotes

# Tree Notation Libraries in Other Languages
If you build a Tree Notation library/SDK in another language, let us know and we'll add a link.

If you are working on a Tree Notation library in a new host language, feel free to post an issue or ask for help in the  TreeNotation subreddit.
 https://reddit.com/r/treenotation subreddit

## How to bump versions
code
 npm run updateVersion NEW_NUMBER

# Alternatives Considered
This is the first Tree Notation library in existence, so there were no alternative implementations. Note and Space were predecessors to Tree Notation. If a better alternative low level notation to Tree Notation is possible, it has yet to be discovered.

All that said, the important part of this repo is not the code but the design patterns. Tree Notation is very simple, and you can implement the patterns contained here in your own code without using this library. In fact, that is often the best way to use Tree Notation!

## Editing in Sublime Text
It is helpful to set `"goto_anything_exclude_gitignore": true` to ignore files in gitignore. Read more here.
 https://breckyunits.com/code/my-sublime-setttings.html here

# ❤️ Public Domain ❤️

import footer.scroll

jtree's People

Contributors

bb010g avatar breck7 avatar carlmjohnson avatar celtic-coder avatar dependabot[bot] avatar jimbo1167 avatar sapatgit avatar xyproto avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jtree's Issues

Implement Good Query API/DSL

At the least we should have something like: knexjs or sizzle(cheerio).

Beyond that, given that Tree Notation has some unique geometric properties, there might be a new language that can take advantage of those.

Beyond that, there may be another type of query language for Grammar backed languages.

Add jtree cli "upgrade" command for updating/upgrading languages

Might require having the diff work done first.

  • Then we can store diffs of grammars versions.
  • Then we can maintain a history of all the versions of a language.
  • Then we can use those for ensuring typesafe upgrades
  • Should be done using convention over configuration?

Any order cell pattern matching

Request from X. Have unit types, like "40ml" and allow pattern matching at the cell level. So you could have unnamed, any order argument functions.

DumbdownLang: Dumbdown improvements

[] table
[] comment
[] compile to HTML or markdown
[] ship as a browser product.
[] provide instructions for using in browser
[] ship with ohayo

Question: how does treenotation differ from IR?

How does is this project different from a intermediate representation like JVM byte code or .net IR?

The FAQ for this project says treenotation is like a base level notation which allows for some cross-platform tooling and interoperability which are qualities of intermediate representations.

Allow for scoped keywords with identical names?

Currently there is 1 global keyword map per grammar. If I want to use the same name for 2 different keywords there is no way to do it.

# program:
plot.scatter
 x Day
person.chromosome
 x 231

# grammar:
keyword x

Currently there is no way to define 2 different keywords named "x". Should I allow this?

The better solution might be grammar switching.

Should we use Tab as XI/ZI?

I don't think we should, but it does potentially make Tree programs play nicer with spreadsheets. We should document why this is a good or bad idea.

Cleanup immutable/mutable code

It is nice to have the mutable methods in one place, but not sure if there is a better way to do this.

The current pattern is ugly and we should have better typing for things like forEach.

Move FAQ to stackoverflow?

Looks like you need 1500 reputation to add a "treenotation" tag. I might have that in one of my accounts but need to check.

JSON to Tree to JSON is inconsistent

I typed out the following JSON in the sandbox:

{
  "foo bar": "foo"
}

Which converted to the following tree:

foo bar foo

However, that tree converts back to the following JSON:

{
  "foo": "bar foo"
}

This JSON differs from the input.

I don't know if this only an issue with whitespaces but there seems to be some inconsistency or incompatibility when mapping between the two.

What is the realtionship between jtree and pytree?

I am wondering how much use pytree is in comparison to jtree... jtree obviously looks a lot more complete for CLI use.

I want to begin playing with tree notation. Is the pytree experience feasible or should I go for a good starting experience with jtree?

GrammarLang: Grammar and Code in Same File

For tiny DSLs, what if we had grammar up top, data below.

Example:

grammar
 productsNode
  root
  inScope productNode
 anyCell
 folderCell
  enum treeComponentFramework/sweepercraft/ treeComponentFramework
 targetCell
  enum browser nodejs
 productNode
  inScope idNode outputFileNameNode folderNode filesNode targetNode exportClassesNode
 idNode
  cells anyCell
 outputFileNameNode
  cells anyCell
 folderNode
  cells folderCell
 filesNode
  catchAllCellType anyCell
 targetNode
  cells targetCell
 exportClassesNode
  cells anyCell anyCell anyCell
data
 product
  id SweeperCraft
  outputFileName SweeperCraft.browser.js
  folder treeComponentFramework/sweepercraft/
  files treeComponentFramework/sweepercraft/SweeperCraft.ts
  target browser
 product
  target browser
  id TreeComponentFramework.Browser
  outputFileName TreeComponentFramework.browser.js
  folder treeComponentFramework
  files worldWideTypes/treeNotationTypes.ts treeComponentFramework/Willow.ts treeComponentFramework/TreeComponentFramework.ts
 product
  target nodejs
  id TreeComponentFramework.Node
  outputFileName TreeComponentFramework.node.js
  folder treeComponentFramework
  files worldWideTypes/treeNotationTypes.ts treeComponentFramework/Willow.ts treeComponentFramework/TreeComponentFramework.ts
  exportClasses AbstractTreeComponentRootNode AbstractTreeComponent AbstractCommander

Libraries Page

Let's build a page like: http://json.org/ which lists all the implementations of libraries in the different languages. It could also help coordinate who is working on what language and what the status of each project is.

Move off TypeScript

Once TreeScript is more stable let's move completely off TypeScript to TreeScript (and run stuff off that for the most part, compiling to JS/WASM later)

Blank Lines best practices?

How should we provide better support for Blank Lines in the Grammar Language?

It's a common request. I feel like we should change the defaults and perhaps make blank lines not errors, and perhaps a default node type, and have Tree Language designers opt in to making them errors.

Show Don't Tell

Redesign of the site should change the TreeNotation.org landing page to a show don't tell, with images, videos, animated gifs, demos, etc.

Meta Tree Notation Library Suite

How can we solve the "meta" problem of how to help others build Tree Notation libraries in different host languages?

Can we provide a universal set of test cases?

Open source/link to PLDB

We need to show people the db so they can see the mountain of work and prior languages this is building on.

GrammarLang: Improve Language Upgrade Best Practices

Can be some tricky dependency cycles with upgrading to newer versions of languages. Should have a design pattern perhaps where we tag a branch for the desired upgrade, or just ship a separate repo with the necessary files from products/ coupled with the upgrade code.

Refresh Designer App

Perhaps use TS as a model: https://typescript-play.js.org/

From user tests:

  • TESTS
  • TEST COVERAGE
  • MIGRATE to TCF
  • Readme updated as you type
  • Fix the ## bug
  • Autoexecute checkbox?
  • Autocomplete always visible?
  • Autocomplete better
  • Infix language!!! If they haven’t done prefix language
  • API examples
  • Better description on + in numbers
  • Have something like “there are X nodeTyprs, that is not one”
  • Change NodeType to lineType???
  • Start ""
  • Blank lines in infer

TreeBase: TreeBase next iteration

[] speed. let's get back to instant startup. Lazy loading? Save indexes?
[] better ohayo integration with TreeBase
[] query build on treebase startup page.
[] surface 10 interesting queries? instant start. something more exciting than what we currentlty have.
[] distribution of key variables on treebase startup page?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.