Remove non-rescript stuff

Author: pbiggar

Makefile

@@ -1,16 +1,11 @@
-# Tablecloth
+# Tablecloth-rescript
 
 [![CircleCI](https://circleci.com/gh/darklang/tablecloth.svg?style=shield)](https://circleci.com/gh/darklang/tablecloth)
 [![Npm](https://badge.fury.io/js/tablecloth-rescript.svg)](https://www.npmjs.com/package/tablecloth-rescript)
-[![Opam](https://img.shields.io/badge/opam_package-0.7.0-brightgreen)](https://opam.ocaml.org/packages/tablecloth-ocaml-base)
 
 Tablecloth is a library that shims over various standard libraries so they have the same function and module names, which using idiomatic types and patterns in each language.
 
-Supports:
-- OCaml (using Base, pipe-last, labels, and snake_case)
-- Rescript (uses Belt, pipe-first, and camelCase)
-- F# (in development - uses FSharp.Core, pipe-last, and camelCase)
-- Elm (just in the sense that it is extremely similar to Elm's standard libraries)
+This is the Rescript implementation, which uses Belt, pipe-first, and camelCase.
 
 **Tablecloth is alpha-quality software, and is pre-1.0. It is currently undergoing
 some significant shifts and some libraries listed below are not available yet.
@@ -22,8 +17,6 @@ Check out the [website](https://www.tablecloth.dev) for our interactive API docu
 
 **Note: these instructions are for the upcoming new version of tablecloth**
 
-### Rescript
-
 Install via npm by:
 
 `npm install tablecloth-rescript`
@@ -32,16 +25,6 @@ Then add to your `bsconfig.json` file:
 
 `"bs-dependencies" : ["tablecloth-rescript"]`
 
-### OCaml
-
-Install via opam:
-
-`opam install tablecloth-ocaml-base`
-
-Then add to your dune file:
-
-`(libraries (tablecloth-ocaml-base ...))`
-
 ## Usage
 
 The recommended way to use Tablecloth is with a top-level open at the beginning of a file.
@@ -61,46 +44,14 @@ let () =
 
 ## Supported versions
 
-### Rescript
-
 Tablecloth supports Rescript 9. [Older versions of Tablecloth](https://www.npmjs.com/package/tablecloth-bucklescript) supported older versions of bs-platform.
 
-### Native
-
-Tablecloth for native OCaml supports OCaml 4.08-4.10 and Base
-v0.12.2/v0.13.2. We are open to supporting other versions:
-
-- OCaml 4.11 is believed to work but is not officially supported as there is no
-  docker container for it in CI.
-- OCaml 4.06 and 4.07 require small tweaks to our build system
-- Base v0.9, v0.10, and v0.11 require small code changes
-- Base v0.14 require small dependency tweaks
-
 ### Development
 
 When developing Tablecloth, you can test it against different versions of
-rescript, OCaml (native) and Base, using the following commands:
+rescript, using the following commands:
 
 - `TC_RESCRIPT_VERSION=7.1.1 make deps-rescript`
-- `TC_BASE_VERSION=v0.14.0 TC_NATIVE_OCAML_SWITCH=4.11.0 make deps-native`
-
-## Design goals of Tablecloth
-
-When switching between functional languages, it can be frustrating to try to
-remember the names of different functions, which are not standardized and differ
-due to history.
-
-At the same time, we recognize that each language has their own idioms, and
-often have mature and optimized standard libraries that we do not wish to replace.
-As such, each version of tablecloth is simple a set of functions which call existing
-standard libraries, and uses idiomatic patterns for the language in question.
-
-Tablecloth was originally written to help port the Darklang frontend from Elm to
-ReasonML. As we used OCaml on the backend, we tried to reuse some libraries by adding
-OCaml versions of the ReasonML functions. However, code reuse was difficult and never
-took off, and we ended up splitting the two libraries when the ReasonML community
-moved to Rescript, which did not have the goal to be compatible with OCaml. When we
-ported the backend from OCaml to F#, we added an F# version.
 
 ## Contributions
 
@@ -114,29 +65,19 @@ Check out the [dedicated guide](./documentation/contributing.md) on contributing
 
 ## Developing
 
-Please refer to the `Makefile` for a complete list of supported actions. Here is
+Please refer to the `package.json` for a complete list of supported actions. Here is
 a handful of useful, supported commands:
 
-- `make deps-native`: Install OCaml dependencies.
-- `make deps-rescript`: Install Rescript dependencies.
-- `make build`: Build the project.
-- `make test`: Run the test suite. You may need to `make build` first.
-- `make check-format`: Check your code is formatted correctly.
-- `make format`: Format code.
-- `cd ocamldoc-json-generator && make deps && make doc`: Build model.json for the website (needs to be updated and checked in whenever the APIs change.)
-
-### Rescript dependencies
-
-- Requires a recent version of [NodeJS](https://nodejs.org/en/)
-
-### OCaml dependencies
-
-- Install OCaml and OPAM [based on your OS](https://ocaml.org/docs/install.html)
-- You may need to run `opam init`
+```
+npm install
+npm run build
+npm run test
+npm run format
+```
 
 ## License
 
-Tablecloth uses the [MIT](./LICENSE) license.
+Tablecloth-rescript uses the [MIT](./LICENSE) license.
 
 ## Authors
 

README.md

@@ -1,11 +1,3 @@
-To deploy to opam
-
-- update /tablecloth-native.opam to version x.y.z
-- git tag -f x.y.z
-- git push origin x.y.z
-- opam-publish tablecloth-native -v x.y.z https://github.com/darklang/tablecloth/archive/x.y.z.tar.gz
-- make the pull request work
-
 To deploy to npm
 
 - npm publish

deploying.md

@@ -3,7 +3,7 @@ title: "Contributing"
 order: "4"
 ---
 
-Tablecloth is an ideal library to contribute to, even if you're new to OCaml / Reason.
+Tablecloth is an ideal library to contribute to, even if you're new to Rescript.
 
 The maintainers are warm and friendly, and the project abides by a [Code of Conduct](../CODE_OF_CONDUCT.md).
 
@@ -22,7 +22,6 @@ Here are some ways to contribute:
 - Improve a function's documentation by discussing an edge-case
 - Check a function cannot throw exceptions (and add a note to the function documentation to that effect)
 - Suggest a new function or module by [creating an issue](https://github.com/darklang/tablecloth/issues/new). 
-- Improve the [documentation site](https://github.com/darklang/tablecloth/tree/master/website)
 - Optimize a function
 
 If you'd like to contribute but don't know where to start [open an
@@ -44,69 +43,3 @@ Many small PR's are better than one big one.
 Don't save up small changes for one big PR if you can avoid it.
 
 Small PR's are less likely to cause conflicts, easier to review and take less effort.
-
-### Design for a concrete use case
-
-Struggling to provide a good example for your function / module? Maybe it shouldn't be in Tablecloth (although writing good examples *is hard*).
-
-Completeness isn't a goal, just because one module has a function doesn't mean all the modules that *can* have that function *should* have it too. 
-
-## Names
-
-### Don't use abbreviations
-
-Use human readable names.
-
-Having an API that is clear is more important than saving three or four characters by dropping letters from a name.
-
-Abbreviations impose additional mental overhead when reading code:
-- You have to translate them back to the 'real' word in your head
-- You have to disambiguate them, does `init` mean `initial` or `initialize` (`List` has both!)
-
-If it's a super common abbreviation, it needs to be justified and explained in the documentation or in [Conventions](./conventions.md).
-
-### Don't be cute
-
-A name that doesn't help you understand what a function does isn't a very good name. 
-
-Needing to understand the function to understand the name is the opposite of how things should work, [naming things backwards](https://stackoverflow.com/questions/7674277/in-functionaljava-list-what-does-snoc-mean) is [for vampires](https://en.wikipedia.org/wiki/Count_Alucard_(character)).
-
-
-### Prefer long names for functions that do something ill-advised or dangerous
-
-You want to give the reader the opportunity to realise something is up. 
-
-A good way to do this is by including `Unsafe` or `Dangerously` in the name.
-
-### Try to use names that Javascripters / OCamlers already know
-
-If one ecosystem already has a name for something, that's going to be the one to
-go for unless there is a good reason not to.
-
-### Module names should not be repeated in function names
-
-A function called `State.runState` is not only redundant but encourages `open`ing modules which does not scale well. 
-
-In files with many unqualified dependencies it is really hard to figure out where functions are coming from.
-
-This can make code difficult to understand, especially if custom infix operators are used as well. 
-
-## Documentation
-
-### Avoid 'simple', 'easy' and 'just'
-
-They don't help anyone understand how anything works, but they can make someone who is struggling with a new concept or module feel inadequate.
-
-### Try not to assume any background knowledge
-
-Everyone has gaps in their knowledge, try to remove roadblocks. External links are really useful here.
-
-### Avoid this style of documentation
-
-> `lfindi ?pos t ~f` returns the smallest `i >= pos` such that `f i t.[i]`, if there is such an `i`. By default, `pos = 0`.
-
-It's incredibly dense, the names are short to the point of basically being symbols and it is self referential. 
-
-Either a longer explanation using real words or an example using real data would have been better.
-
-In Tablecloth, we do both.