functionalscript 0.0.0 → 0.0.126

package/README.md

@@ -1,149 +1,149 @@
-# FunctionalScript
-
-FunctionalScript is a pure functional programming language and a subset of [ECMAScript](https://en.wikipedia.org/wiki/ECMAScript)/[JavaScript](https://en.wikipedia.org/wiki/JavaScript). It's inspired by 
-
-- [JSON](https://en.wikipedia.org/wiki/JSON), as a subset of JavaScript; FunctionalScript is a superset of JSON.
-- [asm.JS](https://en.wikipedia.org/wiki/Asm.js)/[WebAssembly](https://en.wikipedia.org/wiki/WebAssembly), as a subset of JavaScript;
-- [TypeScript](https://en.wikipedia.org/wiki/TypeScript), as a superset of JavaScript.
-
-Try FunctionalScript [here](https://functionalscript.com/).
-
-Create a new FunctionalScript repository on GitHub [here](https://github.com/functionalscript/template/generate).
-
-## JSON
-
-```js
-jsonFile = expression
-expression = primitive | array | objects
-primitive = 'true' | 'false' | 'null' | number | string
-array = '[' (() | items) ']'
-items = expression (() | ',' items)
-object = '{' (() | properties) '}'
-properties = propertyId ':' expression (() | ',' properties)
-propertyId = string
-```
-
-## Stage 0
-
-This stage can be used as an intermediate-code for VMs.
-
-```js
-fjsFile = expression
-expression = primitive | array | object | func | id | propertyAccessor
-func = ('()' | id) '=>' body
-body = '{' statements 'return' expression ';' '}'
-statements = () | (statement statements)
-statement = decl | ifStatement
-decl = `const` id `=` expression `;`
-ifStatement = `if` `(` expression `)` body
-propertyAccessor = expression `[` expression `]`
-call = expression `(` ( expression | ()) `)`
-```
-
-### Stage 0.1. Node.js
-
-```js
-nodeFile = statements 'module.exports' '=' expression ';'
-```
-
-### Stage 0.2. 
-
-#### Operators
-
-```js
-expression = ... | 'undefined' | groupingOperator | binaryOperatorExpression | unaryOperator | conditionalOperator
-groupingOperator = '(' expression ')'
-binaryOperatorExpression = expression binaryOperator expression
-binaryOperator = comparisonOperator | arithmeticOperator | bitwiseOperator | logicalOperators | '??'
-comparisonBinaryOperator = '===' | '!==' | '>' | '<' | '>=' | '<='
-arithmeticBinaryOperator = '+' | '-' | '*' | '/' | '%' | '**'
-bitwiseBinaryOperator = '&' | '|' | '^' | '<<' | '>>' | '>>>'
-logicalBinaryOperator = '&&' | '||'
-unaryOperator = '-' | '~' | '!'
-```
-
-Note: the syntax should be fixed to reflect operator precedents.
-
-No `==`, `!=`, `=...` operators.
-
-#### Function Expression
-
-```js
-func = ('()' | id) '=>' (('{' statements 'return' expression ';' '}') | expression)
-```
-
-#### PropertyAccessor
-
-```js
-propertyAccessor = expression (('[' expression ']') | ('.' id))
-```
-
-```js
-propertyId = string | id
-```
-
-#### BigInt
-
-For example `42n`.
-
-#### Additional Operators
-
-```js
-typeOfOperator = 'typeof' expression
-inOperator = expression 'in' expression
-```
-
-### Stage 0.3. Syntax sugar
-
-Hex, binary and octal literals
-Functions with multiple parameters.
-Spread syntax. For example `...object`.
-Destructing assignments. For example `const {a,b} = exp;`, `const [a, b] = exp`.
-Property Id expression `{ [exp]: exp }`.
-Allow no semicolons.
-Optional comma in arrays and objects.
-Template literals ``const r= `onst r = ${exp}`;``.
-An `if` statement `if (exp) { ... return exp }`
-Multiline strings 
-```js
-'sss\
-   wwww'
-```
-Regular expressions.
-
-## Stage 1
-
-Typing using [JSDoc](https://jsdoc.app/) and TypeScript types.
-
-## Stage 2
-
-Mutable types with exclusive ownership (similar to Rust mutability).
-
-- `let`, `for`, `while` etc.
-  Note: `let` can work as an object name reuse. 
-  In this case, `let` objects can't be used in nested functions. It means we can't reference `let` object.
-  ```js
-  let x = 5 // ok
-  f(x)
-  x = 'hello!' // ok
-  f(x)
-  const r = () => {
-     return x // compilation error
-  }
-  ```
-  Translated into
-  ```js
-  const x0 = 5
-  f(x0)
-  const x1 = 'hello!'  
-  f(x1)
-  ```
-- Generators `function*(){  ... yield ... }`.
-- Async `async () => f(await exp())`.
-- hopefully, we will have [ES pipe operator](https://tc39.es/proposal-pipeline-operator/) at this time.
-- [pattern matching](https://github.com/tc39/proposal-pattern-matching)
-
-Controversial ideas: 
-
-- Import and export `import x from "..."`, `export const x = ...`, `export default = ` e.t.c. This may break `new Function` runners. 
-- Functional-TypeScript as a subset of TypeScript. Note: FunctionalScript doesn't require an additional build step in contrast to TypeScript.
+# FunctionalScript
+
+FunctionalScript is a pure functional programming language and a subset of [ECMAScript](https://en.wikipedia.org/wiki/ECMAScript)/[JavaScript](https://en.wikipedia.org/wiki/JavaScript). It's inspired by 
+
+- [JSON](https://en.wikipedia.org/wiki/JSON), as a subset of JavaScript; FunctionalScript is a superset of JSON.
+- [asm.JS](https://en.wikipedia.org/wiki/Asm.js)/[WebAssembly](https://en.wikipedia.org/wiki/WebAssembly), as a subset of JavaScript;
+- [TypeScript](https://en.wikipedia.org/wiki/TypeScript), as a superset of JavaScript.
+
+Try FunctionalScript [here](https://functionalscript.com/).
+
+Create a new FunctionalScript repository on GitHub [here](https://github.com/functionalscript/template/generate).
+
+## JSON
+
+```js
+jsonFile = expression
+expression = primitive | array | objects
+primitive = 'true' | 'false' | 'null' | number | string
+array = '[' (() | items) ']'
+items = expression (() | ',' items)
+object = '{' (() | properties) '}'
+properties = propertyId ':' expression (() | ',' properties)
+propertyId = string
+```
+
+## Stage 0
+
+This stage can be used as an intermediate-code for VMs.
+
+```js
+fjsFile = expression
+expression = primitive | array | object | func | id | propertyAccessor
+func = ('()' | id) '=>' body
+body = '{' statements 'return' expression ';' '}'
+statements = () | (statement statements)
+statement = decl | ifStatement
+decl = `const` id `=` expression `;`
+ifStatement = `if` `(` expression `)` body
+propertyAccessor = expression `[` expression `]`
+call = expression `(` ( expression | ()) `)`
+```
+
+### Stage 0.1. Node.js
+
+```js
+nodeFile = statements 'module.exports' '=' expression ';'
+```
+
+### Stage 0.2. 
+
+#### Operators
+
+```js
+expression = ... | 'undefined' | groupingOperator | binaryOperatorExpression | unaryOperator | conditionalOperator
+groupingOperator = '(' expression ')'
+binaryOperatorExpression = expression binaryOperator expression
+binaryOperator = comparisonOperator | arithmeticOperator | bitwiseOperator | logicalOperators | '??'
+comparisonBinaryOperator = '===' | '!==' | '>' | '<' | '>=' | '<='
+arithmeticBinaryOperator = '+' | '-' | '*' | '/' | '%' | '**'
+bitwiseBinaryOperator = '&' | '|' | '^' | '<<' | '>>' | '>>>'
+logicalBinaryOperator = '&&' | '||'
+unaryOperator = '-' | '~' | '!'
+```
+
+Note: the syntax should be fixed to reflect operator precedents.
+
+No `==`, `!=`, `=...` operators.
+
+#### Function Expression
+
+```js
+func = ('()' | id) '=>' (('{' statements 'return' expression ';' '}') | expression)
+```
+
+#### PropertyAccessor
+
+```js
+propertyAccessor = expression (('[' expression ']') | ('.' id))
+```
+
+```js
+propertyId = string | id
+```
+
+#### BigInt
+
+For example `42n`.
+
+#### Additional Operators
+
+```js
+typeOfOperator = 'typeof' expression
+inOperator = expression 'in' expression
+```
+
+### Stage 0.3. Syntax sugar
+
+Hex, binary and octal literals
+Functions with multiple parameters.
+Spread syntax. For example `...object`.
+Destructing assignments. For example `const {a,b} = exp;`, `const [a, b] = exp`.
+Property Id expression `{ [exp]: exp }`.
+Allow no semicolons.
+Optional comma in arrays and objects.
+Template literals ``const r= `onst r = ${exp}`;``.
+An `if` statement `if (exp) { ... return exp }`
+Multiline strings 
+```js
+'sss\
+   wwww'
+```
+Regular expressions.
+
+## Stage 1
+
+Typing using [JSDoc](https://jsdoc.app/) and TypeScript types.
+
+## Stage 2
+
+Mutable types with exclusive ownership (similar to Rust mutability).
+
+- `let`, `for`, `while` etc.
+  Note: `let` can work as an object name reuse. 
+  In this case, `let` objects can't be used in nested functions. It means we can't reference `let` object.
+  ```js
+  let x = 5 // ok
+  f(x)
+  x = 'hello!' // ok
+  f(x)
+  const r = () => {
+     return x // compilation error
+  }
+  ```
+  Translated into
+  ```js
+  const x0 = 5
+  f(x0)
+  const x1 = 'hello!'  
+  f(x1)
+  ```
+- Generators `function*(){  ... yield ... }`.
+- Async `async () => f(await exp())`.
+- hopefully, we will have [ES pipe operator](https://tc39.es/proposal-pipeline-operator/) at this time.
+- [pattern matching](https://github.com/tc39/proposal-pattern-matching)
+
+Controversial ideas: 
+
+- Import and export `import x from "..."`, `export const x = ...`, `export default = ` e.t.c. This may break `new Function` runners. 
+- Functional-TypeScript as a subset of TypeScript. Note: FunctionalScript doesn't require an additional build step in contrast to TypeScript.

package/doc/README.md

@@ -1,79 +1,79 @@
-# Documentation
-
-## 1. Creating a New Repository
-
-Creating from a template https://github.com/functionalscript/template/generate
-
-## 1.1. Creating From Scratch 
-
-Prerequisites:
-
-- [Git](https://git-scm.com/).
-- [Node.js](https://nodejs.org/en/).
-- GitHub account.
-
-Creating a new GitHub repository
-
-1. Create a public git repository on GitHub using Node template.
-2. Clone the repository.
-3. Go to the root directory of the cloned repository. 
-4. Run `npm init`. It should create `package.json` file.
-5. Create an `index.js` file in the repository root directory.
-6. Edit the `index.js` file. For example
-    ```js
-    module.exports = "Hello world!"
-    ```
-11. Go to [functionalscript.com](https://functionalscript.com) and enter `github:YOUR_GITHUB_NAME/YOUR_REPOSITORY_NAME`. Press `Build`.
-
-### 1.1. Optional
-
-1. Install [Visual Studio Code](https://code.visualstudio.com/).
-2. Add [TypeScript](https://www.typescriptlang.org/) to your repository for static type checking.
-   1. Run `npm install -D typescript`.
-   2. Run `npx tsc --init`. It should create `tsconfig.json` file.
-   3. Uncomment `"allowJs": true,` and `"checkJs": true` in the `tsconfig.json` file.
-
-## 2. Language
-
-### 2.1. Exports
-
-```js
-module.exports = 'Hello world!
-```
-
-```js
-module.exports = { a: 'hello', b: 42 }
-```
-
-```js
-module.exports = x => x * x
-```
-
-### 2.2. Reference Another Module
-
-#### 2.2.1. Local File
-
-```js
-const x = require('./folder/index.js')
-```
-
-### 2.2.2. External Module
-
-Run `npm install -D github:REPO/PACKAGE`
-
-```js
-const x = require(`PACKAGE/DIR/FILE.js`)
-```
-
-### 2.3. Functions
-
-```js
-const f = x => x * x
-const fResult = f(42)
-
-const plus = a => b => a + b
-const plusResult = plus(a)(b)
-
-const sum = ar => ar.reduce((a, i) => a + i, 0)
-const sumResult = sum([1, 2, 3])
-```
+# Documentation
+
+## 1. Creating a New Repository
+
+Creating from a template https://github.com/functionalscript/template/generate
+
+## 1.1. Creating From Scratch 
+
+Prerequisites:
+
+- [Git](https://git-scm.com/).
+- [Node.js](https://nodejs.org/en/).
+- GitHub account.
+
+Creating a new GitHub repository
+
+1. Create a public git repository on GitHub using Node template.
+2. Clone the repository.
+3. Go to the root directory of the cloned repository. 
+4. Run `npm init`. It should create `package.json` file.
+5. Create an `index.js` file in the repository root directory.
+6. Edit the `index.js` file. For example
+    ```js
+    module.exports = "Hello world!"
+    ```
+11. Go to [functionalscript.com](https://functionalscript.com) and enter `github:YOUR_GITHUB_NAME/YOUR_REPOSITORY_NAME`. Press `Build`.
+
+### 1.1. Optional
+
+1. Install [Visual Studio Code](https://code.visualstudio.com/).
+2. Add [TypeScript](https://www.typescriptlang.org/) to your repository for static type checking.
+   1. Run `npm install -D typescript`.
+   2. Run `npx tsc --init`. It should create `tsconfig.json` file.
+   3. Uncomment `"allowJs": true,` and `"checkJs": true` in the `tsconfig.json` file.
+
+## 2. Language
+
+### 2.1. Exports
+
+```js
+module.exports = 'Hello world!
+```
+
+```js
+module.exports = { a: 'hello', b: 42 }
+```
+
+```js
+module.exports = x => x * x
+```
+
+### 2.2. Reference Another Module
+
+#### 2.2.1. Local File
+
+```js
+const x = require('./folder/index.js')
+```
+
+### 2.2.2. External Module
+
+Run `npm install -D github:REPO/PACKAGE`
+
+```js
+const x = require(`PACKAGE/DIR/FILE.js`)
+```
+
+### 2.3. Functions
+
+```js
+const f = x => x * x
+const fResult = f(42)
+
+const plus = a => b => a + b
+const plusResult = plus(a)(b)
+
+const sum = ar => ar.reduce((a, i) => a + i, 0)
+const sumResult = sum([1, 2, 3])
+```

package/index.js

@@ -1,82 +1,82 @@
-"use strict";
-
-const lib = require('./lib')
-
-const todo = () => lib.panic('not implemented')
-
-/** @type {<F>(c: string, found: (before: string, after: string) => F, notFound: (c: string, source: string) => F) => (source: string) => F} */
-const splitOne = (c, found, notFound) => source => {
-    const i = source.indexOf(c)
-    return i !== -1 ? found(source.substring(0, i), source.substring(i + 1)) : notFound(c, source)
-}
-
-/** @type {<T>(f: (_: T) => boolean) => (_: Iterable<T>) => boolean} */
-const every = f => i => {
-    for (let e of i) {
-        if (!f(e)) {
-            return false
-        }
-    }
-    return true
-}
-
-/** @typedef {{org: string, name: string}} RepoId */
-/** @typedef {{repo: RepoId}} ModuleRepoId */
-/** @typedef {{repo: RepoId, branch: string}} ModuleRepoBranchId */
-/** @typedef {{repo: RepoId, commit: string}} ModuleRepoCommitId */
-/** @typedef {ModuleRepoId|ModuleRepoBranchId|ModuleRepoCommitId} ModuleId */
-
-/** @typedef {(..._: string[]) => string} GetMsg */
-/** @typedef {'expected'|'unknownProtocol'} ErrorId */
-/** @typedef {{[_ in ErrorId]: GetMsg}} ErrorMap */
-/** @typedef {{ id: ErrorId, params: string[]}} ErrorValue */
-
-/**
- * @template T
- * @typedef {<R>(v: (_: T) => R, e: (_: ErrorValue) => R) => R} Result 
- */
-
-/** @type {<T>(_: T) => Result<T>} */
-const value = v => vf => vf(v)
-
-/**
- * @typedef {<R, T>(_: (_: T) => R, e: (_: ErrorValue) => R) => R} ErrorResult
- */
-
-/** @type {(e: ErrorValue) => ErrorResult} */
-const error = e => (_, ef) => ef(e)
-
-/** @type {(id: ErrorId) => (...params: string[]) => ErrorResult} */
-const createError = id => (...params) => error({ id, params })
-
-/** @type {(_: string) => Result<ModuleId>} */
-const parseRepo = repo => {
-    const s = repo.split('/')
-    return s.length === 2 ? value({ repo: { org: s[0], name: s[1] } }) : createError('expected')('/', repo)
-}
-
-/** @type {(_: string) => boolean} */
-const isCommit = name => name.length === 40 && every(c => "0123456789ABCDEFabcdef".includes(c))(name)
-
-/** @type {(repo: string, branch: string) => Result<ModuleId>} */
-const parseRepoAndBranchCommit = (repo, branchCommit) => 
-    parseRepo(repo)(
-        ({repo}) => value(isCommit(branchCommit) ? { repo, commit: branchCommit } : { repo, branch: branchCommit }), 
-        error)
-
-const parseGitHubId = splitOne('#', parseRepoAndBranchCommit, (_, repo) => parseRepo(repo))
-
-/** @type {(protocol: string, id: string) => Result<ModuleId>} */
-const parseProtocolAndId = (protocol, id) => protocol === 'github'
-    ? parseGitHubId(id) : createError('unknownProtocol')(protocol)
-
-module.exports = {
-    every,
-    isCommit,
-    parseModuleUrl: splitOne(':', parseProtocolAndId, createError('expected')),
-    /** @type {ErrorMap} */
-    errorMap: {
-        expected: (c, s) => `expected '${c}' in '${s}'`,
-        unknownProtocol: protocol => `unknown protocol '${protocol}'`,
-    },
-}
+"use strict";
+
+const lib = require('./lib')
+
+const todo = () => lib.panic('not implemented')
+
+/** @type {<F>(c: string, found: (before: string, after: string) => F, notFound: (c: string, source: string) => F) => (source: string) => F} */
+const splitOne = (c, found, notFound) => source => {
+    const i = source.indexOf(c)
+    return i !== -1 ? found(source.substring(0, i), source.substring(i + 1)) : notFound(c, source)
+}
+
+/** @type {<T>(f: (_: T) => boolean) => (_: Iterable<T>) => boolean} */
+const every = f => i => {
+    for (let e of i) {
+        if (!f(e)) {
+            return false
+        }
+    }
+    return true
+}
+
+/** @typedef {{org: string, name: string}} RepoId */
+/** @typedef {{repo: RepoId}} ModuleRepoId */
+/** @typedef {{repo: RepoId, branch: string}} ModuleRepoBranchId */
+/** @typedef {{repo: RepoId, commit: string}} ModuleRepoCommitId */
+/** @typedef {ModuleRepoId|ModuleRepoBranchId|ModuleRepoCommitId} ModuleId */
+
+/** @typedef {(..._: string[]) => string} GetMsg */
+/** @typedef {'expected'|'unknownProtocol'} ErrorId */
+/** @typedef {{[_ in ErrorId]: GetMsg}} ErrorMap */
+/** @typedef {{ id: ErrorId, params: string[]}} ErrorValue */
+
+/**
+ * @template T
+ * @typedef {<R>(v: (_: T) => R, e: (_: ErrorValue) => R) => R} Result 
+ */
+
+/** @type {<T>(_: T) => Result<T>} */
+const value = v => vf => vf(v)
+
+/**
+ * @typedef {<R, T>(_: (_: T) => R, e: (_: ErrorValue) => R) => R} ErrorResult
+ */
+
+/** @type {(e: ErrorValue) => ErrorResult} */
+const error = e => (_, ef) => ef(e)
+
+/** @type {(id: ErrorId) => (...params: string[]) => ErrorResult} */
+const createError = id => (...params) => error({ id, params })
+
+/** @type {(_: string) => Result<ModuleId>} */
+const parseRepo = repo => {
+    const s = repo.split('/')
+    return s.length === 2 ? value({ repo: { org: s[0], name: s[1] } }) : createError('expected')('/', repo)
+}
+
+/** @type {(_: string) => boolean} */
+const isCommit = name => name.length === 40 && every(c => "0123456789ABCDEFabcdef".includes(c))(name)
+
+/** @type {(repo: string, branch: string) => Result<ModuleId>} */
+const parseRepoAndBranchCommit = (repo, branchCommit) => 
+    parseRepo(repo)(
+        ({repo}) => value(isCommit(branchCommit) ? { repo, commit: branchCommit } : { repo, branch: branchCommit }), 
+        error)
+
+const parseGitHubId = splitOne('#', parseRepoAndBranchCommit, (_, repo) => parseRepo(repo))
+
+/** @type {(protocol: string, id: string) => Result<ModuleId>} */
+const parseProtocolAndId = (protocol, id) => protocol === 'github'
+    ? parseGitHubId(id) : createError('unknownProtocol')(protocol)
+
+module.exports = {
+    every,
+    isCommit,
+    parseModuleUrl: splitOne(':', parseProtocolAndId, createError('expected')),
+    /** @type {ErrorMap} */
+    errorMap: {
+        expected: (c, s) => `expected '${c}' in '${s}'`,
+        unknownProtocol: protocol => `unknown protocol '${protocol}'`,
+    },
+}