Add Spellchecker (#252)

Author: jcubic

.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+skip = ./node_modules*,./dist/*,./package-lock.json,./lib/srfi/*,./assets/UnicodeData.txt,./scripts/numerals.scm

.github/workflows/build.yaml

@@ -1,5 +1,15 @@
 name: Build and test
-on: [push, pull_request]
+
+on:
+  push:
+    branches:
+      - master
+      - devel
+  pull_request:
+    branches:
+      - master
+      - devel
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/codespell.yaml

@@ -0,0 +1,25 @@
+name: Codespell
+
+on:
+  push:
+    branches:
+      - master
+      - devel
+  pull_request:
+    branches:
+      - master
+      - devel
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

ARCHITECTURE.md

@@ -7,7 +7,7 @@ Main interpreter data flow.
 Main public function is `exec` that accept string (code) and Environment instance. If environment is not specified it use main user environment (same as lips.env) which is child of global environment.
 
 `exec` use internal `parse` function that is JavaScript generator that parse single S-Expression and `exec` use `evaluate` to evaluate the expression.
-`evaluate` use multiple features like handling of Syntax, Macros and it auto resolve promises. `evaluate` may or may not return a promise. But `exec` always return a promise, so it's easier to use. You can never know which expression return a promise and which don't. `evaluate` also use `apply` function that was inspired by meta circual evaluator (but it was refactored into this state, it was not like this from beginning).
+`evaluate` use multiple features like handling of Syntax, Macros and it auto resolve promises. `evaluate` may or may not return a promise. But `exec` always return a promise, so it's easier to use. You can never know which expression return a promise and which don't. `evaluate` also use `apply` function that was inspired by meta circular evaluator (but it was refactored into this state, it was not like this from beginning).
 
 ## UML Diagram of all classes
 
@@ -16,7 +16,7 @@ Main public function is `exec` that accept string (code) and Environment instanc
 ## Lexer
 
 Lexer is created as simple state machine with `Lexer._rules` that specify
-all the states. The sate change is simple it can change from null to given
+all the states. The state change is simple it can change from null to given
 state for a given token (e.g. symbol), remain in same state and move from
 given state to null. The last change produce new token. Rules are dynamic
 the parser can be update by syntax extensions so `Lexer.rules` is a getter

CHANGELOG.md

@@ -57,7 +57,7 @@
 * property throw error when name is used without ellipsis
 * fix using dot notation inside syntax-rules macros
 * typecheck `string->symbol` and `symbol->string`
-* fix `parent.frame` inside `Intepreter`
+* fix `parent.frame` inside `Interpreter`
 * fix `eval` without env
 * fix quote as delimiter
 * fix comma dot as two tokens
@@ -362,7 +362,7 @@
 * `if` no longer require boolean as cond
 * change how arrays are presented, they are look like scheme vector `#(...)`
 * rename `string` to `repr`
-* new API `lips.Intepreter` - for using interpreter that have different stdout/stdin
+* new API `lips.Interpreter` - for using interpreter that have different stdout/stdin
 * balanced_parenthesis now throw exception on broken code
 * remove global env from public API (you can still access it using `env.parent`)
 * remove `->` function (it will collide with SRFI 197 that may be implemented in the future)
@@ -395,7 +395,7 @@
 * improve balancing parenthesis
 * expose balanced method in public API (preferred name)
 * optional brackets
-* `interator?` function and detection if iterators from `repr` and `type` [#51](https://github.com/jcubic/lips/issues/51)
+* `iterator?` function and detection if iterators from `repr` and `type` [#51](https://github.com/jcubic/lips/issues/51)
 * `add-repr!` function to add string representations to objects
 * new `string=?`, `sort`, `in`, `list-tail` and `bound?` functions
 * add new `exit` function into executable interpreter
@@ -689,7 +689,7 @@
 ### Features
 * new nth and reverse functions
 * new type checking functions null? regex? pair? string? number? symbol? array? object? boolean?
-* add lips source code that throwed exception in JavaScript error message
+* add lips source code that threw exception in JavaScript error message
 ### Bug fixes
 * fix lambda with rest parameter
 ### Breaking

LICENSE

@@ -71,7 +71,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 --------------------------------------------------------------------------------
 
-Part of the library (contentloaded function) licesed with
+Part of the library (contentloaded function) licensed with
 
 Copyright (c) 2005-2010 Diego Perini and NWBOX S.a.s.
 

Makefile

@@ -1,5 +1,3 @@
-SHELL=/bin/bash
-
 .PHONY: publish test coveralls lint zero coverage
 
 VERSION=1.0.0-beta.16
@@ -67,10 +65,10 @@ assets/classDiagram.svg: assets/classDiagram
 
 README.md: templates/README.md dist/lips.js .$(VERSION)
 	$(GIT) branch | grep '* devel' > /dev/null && $(SED) -e "s/{{VER}}/DEV/g" -e \
-	"s/{{VER_DASH}}/$(VERSION_DASH)/g" -e "s/{{BRANCH}}/$(BRANCH)/g" -e "s/{{CHECKSUM}}/$(TESTS_CHECKSUM)/g" \
+	"s/{{VER_DASH}}/$(VERSION_DASH)/g" -e "s#{{BRANCH}}#$(BRANCH)#g" -e "s/{{CHECKSUM}}/$(TESTS_CHECKSUM)/g" \
 	-e "s/{{YEAR}}/${YEAR}/g"  -e "s/{{DATE}}/${DATE_SHORT}/" -e "s/{{COMMIT}}/$(COMMIT)/g" \
 	< templates/README.md > README.md || \
-	$(SED) -e "s/{{VER}}/$(VERSION)/g" -e "s/{{BRANCH}}/$(BRANCH)/g" -e "s/{{YEAR}}/${YEAR}/g" \
+	$(SED) -e "s/{{VER}}/$(VERSION)/g" -e "s#{{BRANCH}}#$(BRANCH)#g" -e "s/{{YEAR}}/${YEAR}/g" \
 	-e "s/{{CHECKSUM}}/$(TESTS_CHECKSUM)/g" -e "s/{{COMMIT}}/$(COMMIT)/g" -e "s/{{DATE}}/${DATE_SHORT}/" \
 	-e "s/{{VER_DASH}}/$(VERSION_DASH)/g" < templates/README.md > README.md
 

README.md

@@ -7,7 +7,7 @@
 [![npm](https://img.shields.io/badge/npm-1.0.0%E2%80%93beta.16-blue.svg)](https://www.npmjs.com/package/@jcubic/lips)
 ![1.0.0 Complete](https://img.shields.io/github/milestones/progress-percent/jcubic/lips/1?label=1.0.0%20Complete)
 [![Build and test](https://github.com/jcubic/lips/actions/workflows/build.yaml/badge.svg?branch=devel&event=push)](https://github.com/jcubic/lips/actions/workflows/build.yaml)
-[![Coverage Status](https://coveralls.io/repos/github/jcubic/lips/badge.svg?branch=devel&27bf4fb65e05b7570ad966f858c29bcc)](https://coveralls.io/github/jcubic/lips?branch=devel)
+[![Coverage Status](https://coveralls.io/repos/github/jcubic/lips/badge.svg?branch=devel&61cb7f36a3668cabc9125f4c4bce1141)](https://coveralls.io/github/jcubic/lips?branch=devel)
 [![Join Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jcubic/lips)
 ![NPM Download Count](https://img.shields.io/npm/dm/@jcubic/lips)
 ![JSDelivr Download count](https://img.shields.io/jsdelivr/npm/hm/@jcubic/lips)
@@ -79,7 +79,7 @@ https://github.com/jcubic/lips/blob/master/lib/js/bookmark.js
 ```
 
 Create any link in your bookmarks, edit it and copy paste the content of that file.
-Affter you click on the link it will create the REPL at the bottom of the page.
+After you click on the link it will create the REPL at the bottom of the page.
 (NOTE: It may not work on every page because of content security policy;
 e.g. google.com or gihub.com)
 
@@ -203,7 +203,7 @@ Executables also return a S-Expression according to SRFI-176 use `lips --version
 
 ## Limitations
 Because LIPS is tree walking interpreter sometimes it may be slow. Especially if you want to
-process long arrays and use callback function. If the array is quite large each pice of code
+process long arrays and use callback function. If the array is quite large each piece of code
 inside the callback may slow down the processing. For example see:
 
 script [reference.scm](https://github.com/jcubic/lips/blob/devel/scripts/reference.scm)
@@ -222,12 +222,12 @@ something like this:
    (arr.sort fn))
 ```
 
-Another example of slow performace is using LIPS with React, the more code you put into components
+Another example of slow performance is using LIPS with React, the more code you put into components
 the slower the app will become.
 
 Examples:
 * [Preact app that update SVG](https://codepen.io/jcubic/pen/PojYxBP) - it requires to use debounce.
-* [React with Hooks](https://codepen.io/jcubic/pen/PoKQmpq?editors=1000) - on click the UI freezes for ~300ms, you can see warnigs in dev tools.
+* [React with Hooks](https://codepen.io/jcubic/pen/PoKQmpq?editors=1000) - on click the UI freezes for ~300ms, you can see warnings in dev tools.
 
 The issue with performance is tracked in [#197](https://github.com/jcubic/lips/issues/197).