feat(#3400): generate only es6 -> implement

Author: Serhii Khoma

.gitignore

@@ -54,3 +54,5 @@ idris2docs_venv
 
 # macOS
 .DS_Store
+node_modules
+package-lock.json

docs/source/backends/javascript.rst

@@ -1,5 +1,5 @@
 ***********************************
-Javascript and Node Code Generators
+Javascript (Browser and Node) Code Generators
 ***********************************
 
 There are two javascript code generators, ``node`` and ``javascript``. There are two
@@ -30,11 +30,19 @@ expression.
 
 
 .. code-block:: idris
+    module My.Module
 
-    %foreign "node:lambda:fp=>require('fs').fstatSync(fp.fd, {bigint: false}).size"
+    %foreign "node:support"
     prim__fileSize : FilePtr -> PrimIO Int
 
-``require`` can be used to import javascript modules.
+And in `./support/node/My.Module.js`
+
+.. code-block:: js
+    import fs from 'node:fs'
+
+    export const prim__fileSize = fp => fs.fstatSync(fp.fd, {bigint: false}).size
+
+``require`` cannot be used to import javascript modules.
 
 For completion below an example of a foreign available only with ``browser`` codegen:
 

docs/source/ffi/ffi.rst

@@ -87,24 +87,30 @@ or ``javascript``. The former two are mutually exclusive while ``javascript``
 FFI specifiers apply both when building for the browser and when building for
 NodeJS.
 
-Javascript specifiers must be further specialized as ``lambda``, ``support``,
-or ``stringIterator``.
+Javascript specifiers must be further specialized as ``lambda``, ``support``.
 
 The syntax, therefore, is ``node:lambda:some_func`` (for the NodeJS-specific
 FFI and a lambda that executes a function named ``some_func``).
 
 When using the ``support`` option, you also specify the name of the support
-file. Idris will look in all ``data`` directories under a ``js`` subfolder
+file. Idris will look in all ``data`` directories under a ``javascript`` subfolder
 for a file with this name. These file names should be distinct for your
 project so they don't collide with support files from other projects
 further on in the build process for an executable. Suppose your package is
 named "http-idris" and you have FFI specifiers like
-``node:support:http_request,http_idris`` in your Idris code. You should make
-sure a data directory in scope has a ``js`` directory with an
-``http_idris.js`` file in it. Another important note is that functions
-within this file must be prefixed with ``http_idris_``; therefore, the
-function referred to in the example we give here would need to be named
-``http_idris_http_request`` in the ``http_idris.js`` support file.
+``node:support`` in your Idris code. You should make
+sure a `support` directory has a ``node`` directory with an
+``My.Module.js`` file in it. Functions
+in ``My.Module.js`` file must have the same name as a name of Idris function.
+
+For example if You will write in ./src/My/Module.idr:
+1. `%foreign "javascript:support" add : Int -> Int -> Int` will look in `./support/js/My.Module.js` for `export const add = (x, y) => x + y`
+2. `%foreign "node:support" add : Int -> Int -> Int` will look in `./support/node/My.Module.js` for `export const add = (x, y) => x + y`
+3. `%foreign "browser:support" add : Int -> Int -> Int` will look in `./support/browser/My.Module.js` for `export const add = (x, y) => x + y`
+4. `%foreign "browser:support:my_globally_unique_file_name" add : Int -> Int -> Int` will look in `./support/browser/my_globally_unique_file_name.js` for `export const add = (x, y) => x + y`
+5. `%foreign "browser:support:my_func,my_globally_unique_file_name" add : Int -> Int -> Int` will look in `./support/browser/my_globally_unique_file_name.js` for `export const my_func = (x, y) => x + y`
+
+NOTE: If You use `%foreign "browser:support:my_globally_unique_file_name"`, then `my_globally_unique_file_name.js` should be unique in the whole internet. Suppose You installed `lib1` and `lib2` from github, suppose they both have `./support/browser/my_globally_unique_file_name.js`. Idris will try to copy `my_globally_unique_file_name.js` into `./build/exec/browser/my_globally_unique_file_name.js`. Which one it will prefer? From `lib1` or `lib2`? The lib that is first in `IDRIS2_DATA` path.
 
 FFI Example
 -----------

eslint.config.js

@@ -0,0 +1,33 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import { includeIgnoreFile } from "@eslint/compat";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const gitignorePath = path.resolve(__dirname, ".gitignore");
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  includeIgnoreFile(gitignorePath),
+  { files: ["**/*.{js,mjs,cjs,ts}"] },
+  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+  pluginJs.configs.recommended,
+  {
+    rules: {
+      "no-unused-vars": [
+        "error",
+        {
+          args: "all",
+          argsIgnorePattern: "^_",
+          caughtErrors: "all",
+          caughtErrorsIgnorePattern: "^_",
+          destructuredArrayIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+        },
+      ],
+    },
+  },
+];

flake.nix

@@ -85,7 +85,8 @@
           });
           inherit buildIdris;
           devShells.default = pkgs.mkShell.override { stdenv = stdenv'; } {
-            packages = idris2Pkg.buildInputs;
+            packages = [ idris2Pkg.buildInputs chez pkgs.python3 ];
+            SCHEME="scheme";
           };
         };
     in lib.mkOvrOptsFlake

idris2api.ipkg

@@ -29,7 +29,7 @@ modules =
     Compiler.ES.Ast,
     Compiler.ES.Codegen,
     Compiler.ES.Doc,
-    Compiler.ES.Javascript,
+    Compiler.ES.Browser,
     Compiler.ES.Node,
     Compiler.ES.State,
     Compiler.ES.TailRec,

libs/base/System.idr

@@ -14,12 +14,6 @@ import System.File
 supportC : (fn : String) -> String
 supportC fn = "C:\{fn}, libidris2_support, idris_support.h"
 
-||| Shorthand for referring to the Node system support library
-|||
-||| @ fn the function name to refer to in the js/system_support.js file
-supportNode : (fn : String) -> String
-supportNode fn = "node:support:\{fn},support_system"
-
 ||| Shorthand for referring to libc 6
 |||
 ||| @ fn the function name to refer to in libc 6
@@ -86,16 +80,16 @@ getArgs = do
               else pure []
 
 %foreign libc "getenv"
-         "node:lambda: n => process.env[n]"
+         "node:lambda:n => process.env[n]"
 prim__getEnv : String -> PrimIO (Ptr String)
 
 %foreign supportC "idris2_getEnvPair"
 prim__getEnvPair : Int -> PrimIO (Ptr String)
 %foreign supportC "idris2_setenv"
-         supportNode "setEnv"
+         "node:support"
 prim__setEnv : String -> String -> Int -> PrimIO Int
 %foreign supportC "idris2_unsetenv"
-         supportNode "unsetEnv"
+         "node:support"
 prim__unsetEnv : String -> PrimIO Int
 
 %foreign "C:idris2_enableRawMode, libidris2_support, idris_support.h"
@@ -198,7 +192,7 @@ unsetEnv var
         pure $ ok == 0
 
 %foreign "C:idris2_system, libidris2_support, idris_system.h"
-         supportNode "spawnSync"
+         "node:support"
 prim__system : String -> PrimIO Int
 
 ||| Execute a shell command, returning its termination status or -1 if an error

libs/base/System/Clock.idr

@@ -136,7 +136,7 @@ clockTimeUtc = fromPrim prim__clockTimeUtc
 
 %foreign "scheme:blodwen-clock-time-process"
          "RefC:clockTimeProcess"
-         "javascript:support:clockTimeProcess,support_system_clock"
+         "javascript:support"
 prim__clockTimeProcess : PrimIO OSClock
 
 ||| Get the amount of time used by the current process.
@@ -145,7 +145,7 @@ clockTimeProcess = fromPrim prim__clockTimeProcess
 
 %foreign "scheme:blodwen-clock-time-thread"
          "RefC:clockTimeThread"
-         "javascript:support:clockTimeThread,support_system_clock"
+         "javascript:support"
 prim__clockTimeThread : PrimIO OSClock
 
 ||| Get the amount of time used by the current thread.

libs/base/System/Directory.idr

@@ -17,12 +17,6 @@ DirPtr = AnyPtr
 supportC : (fn : String) -> String
 supportC fn = "C:\{fn}, libidris2_support, idris_directory.h"
 
-||| Shorthand for referring to the Node system support library
-|||
-||| @ fn the function name to refer to in the js/system_support.js file
-supportNode : (fn : String) -> String
-supportNode fn = "node:support:\{fn},support_system_directory"
-
 ok : HasIO io => a -> io (Either FileError a)
 ok x = pure (Right x)
 
@@ -31,27 +25,27 @@ ok x = pure (Right x)
 prim__currentDir : PrimIO (Ptr String)
 
 %foreign supportC "idris2_changeDir"
-         supportNode "changeDir"
+         "node:support"
 prim__changeDir : String -> PrimIO Int
 
 %foreign supportC "idris2_createDir"
-         supportNode "createDir"
+         "node:support"
 prim__createDir : String -> PrimIO Int
 
 %foreign supportC "idris2_openDir"
-         supportNode "openDir"
+         "node:support"
 prim__openDir : String -> PrimIO DirPtr
 
 %foreign supportC "idris2_closeDir"
-         supportNode "closeDir"
+         "node:support"
 prim__closeDir : DirPtr -> PrimIO ()
 
 %foreign supportC "idris2_removeDir"
-         supportNode "removeDir"
+         "node:support"
 prim__removeDir : String -> PrimIO ()
 
 %foreign supportC "idris2_nextDirEntry"
-         supportNode "dirEntry"
+         "node:support"
 prim__dirEntry : DirPtr -> PrimIO (Ptr String)
 
 ||| Data structure for managing the pointer to a directory.

libs/base/System/Errno.idr

@@ -4,7 +4,7 @@ module System.Errno
 %default total
 
 %foreign "C:idris2_getErrno, libidris2_support, idris_support.h"
-         "node:support:getErrno,support_system"
+         "node:support"
 prim__getErrno : PrimIO Int
 
 %foreign "C:idris2_strerror, libidris2_support, idris_support.h"

libs/base/System/File/Buffer.idr

@@ -13,11 +13,11 @@ import Data.Buffer
 %default total
 
 %foreign supportC "idris2_readBufferData"
-         "node:lambda:(f,b,l,m) => require('fs').readSync(f.fd,b,l,m)"
+         "node:support"
 prim__readBufferData : FilePtr -> Buffer -> (offset : Int) -> (maxbytes : Int) -> PrimIO Int
 
 %foreign supportC "idris2_writeBufferData"
-         "node:lambda:(f,b,l,m) => require('fs').writeSync(f.fd,b,l,m)"
+         "node:support"
 prim__writeBufferData : FilePtr -> Buffer -> (offset : Int) -> (size : Int) -> PrimIO Int
 
 ||| Read the data from the file into the given buffer.

libs/base/System/File/Error.idr

@@ -12,7 +12,7 @@ import public System.File.Types
 prim__error : FilePtr -> PrimIO Int
 
 %foreign supportC "idris2_fileErrno"
-         supportNode "fileErrno"
+         "node:support"
 prim__fileErrno : PrimIO Int
 
 ||| The types of errors that can occur during file operations.

libs/base/System/File/Handle.idr

@@ -8,11 +8,11 @@ import public System.File.Types
 %default total
 
 %foreign supportC "idris2_openFile"
-         supportNode "openFile"
+         "node:support:system_open" -- why specify file? bc this function uses some dependency
 prim__open : String -> String -> PrimIO FilePtr
 
 %foreign supportC "idris2_closeFile"
-         "node:lambda:(fp) => require('fs').closeSync(fp.fd)"
+         "node:support"
 prim__close : FilePtr -> PrimIO ()
 
 ||| Open the given file name with the specified mode.

libs/base/System/File/Meta.idr

@@ -16,14 +16,14 @@ FileTimePtr : Type
 FileTimePtr = AnyPtr
 
 %foreign supportC "idris2_fileSize"
-         "node:lambda:fp=>require('fs').fstatSync(fp.fd).size"
+         "node:support"
 prim__fileSize : FilePtr -> PrimIO Int
 
 %foreign supportC "idris2_fileSize"
 prim__fPoll : FilePtr -> PrimIO Int
 
 %foreign supportC "idris2_fileTime"
-         "node:support:filetime,support_system_file"
+         "node:support"
 prim__fileTime : FilePtr -> PrimIO FileTimePtr
 
 %foreign supportC "idris2_filetimeAccessTimeSec"
@@ -51,7 +51,7 @@ prim__filetimeStatusTimeSec : FileTimePtr -> PrimIO Int
 prim__filetimeStatusTimeNsec : FileTimePtr -> PrimIO Int
 
 %foreign supportC "idris2_fileIsTTY"
-         "node:lambda:fp=>Number(require('tty').isatty(fp.fd))"
+         "node:support"
 prim__fileIsTTY : FilePtr -> PrimIO Int
 
 ||| Check if a file exists for reading.
@@ -154,4 +154,3 @@ fPoll (FHandle f)
 export
 isTTY : HasIO io => (h : File) -> io Bool
 isTTY (FHandle f) = (/= 0) <$> primIO (prim__fileIsTTY f)
-

libs/base/System/File/Permissions.idr

@@ -7,7 +7,7 @@ import public System.File.Types
 %default total
 
 %foreign supportC "idris2_chmod"
-         supportNode "chmod"
+         "node:support"
 prim__chmod : String -> Int -> PrimIO Int
 
 ||| The UNIX file modes.

libs/base/System/File/Process.idr

@@ -11,10 +11,10 @@ import public System.File.Types
          "node:lambda:()=>0"
 prim__flush : FilePtr -> PrimIO Int
 %foreign supportC "idris2_popen"
-         supportNode "popen"
+         "node:support:system_open" -- why specify file? bc this function uses some dependency
 prim__popen : String -> String -> PrimIO FilePtr
 %foreign supportC "idris2_pclose"
-         supportNode "pclose"
+         "node:support:system_removeFileAndPclose" -- why specify file? bc this function uses some dependency
 prim__pclose : FilePtr -> PrimIO Int
 
 data Popen2Result : Type where [external]

libs/base/System/File/ReadWrite.idr

@@ -13,28 +13,29 @@ import System.FFI
 %default total
 
 %foreign supportC "idris2_seekLine"
-         supportNode "seekLine"
+         "node:support"
 prim__seekLine : FilePtr -> PrimIO Int
 
 %foreign supportC "idris2_readLine"
-         supportNode "readLine"
+         "node:support:system_readLine"  -- why specify file? bc this function uses some dependency
 prim__readLine : FilePtr -> PrimIO (Ptr String)
 
 %foreign supportC "idris2_readChars"
 prim__readChars : Int -> FilePtr -> PrimIO (Ptr String)
+
 %foreign "C:fgetc,libc 6"
 prim__readChar : FilePtr -> PrimIO Int
 
 %foreign supportC "idris2_writeLine"
-         "node:lambda:(filePtr, line) => require('fs').writeSync(filePtr.fd, line, undefined, 'utf-8')"
+         "node:support"
 prim__writeLine : FilePtr -> String -> PrimIO Int
 
 %foreign supportC "idris2_eof"
          "node:lambda:f=>(f.eof?1:0)"
 prim__eof : FilePtr -> PrimIO Int
 
 %foreign supportC "idris2_removeFile"
-         supportNode "removeFile"
+         "node:support:system_removeFileAndPclose"  -- why specify file? bc this function uses some dependency
 prim__removeFile : String -> PrimIO Int
 
 ||| Seek through the next newline.

libs/base/System/File/Support.idr

@@ -9,13 +9,6 @@ public export
 supportC : (fn : String) -> String
 supportC fn = "C:\{fn}, libidris2_support, idris_file.h"
 
-||| Shorthand for referring to the Node system support library
-|||
-||| @ fn the function name to refer to in the js/system_support_file.js file
-public export
-supportNode : (fn : String) -> String
-supportNode fn = "node:support:\{fn},support_system_file"
-
 ||| Wrap x in the `Right` part of an `io . Either`.
 export
 ok : HasIO io => (x : a) -> io (Either err a)

libs/base/System/Info.idr

@@ -23,7 +23,7 @@ isWindows : Bool
 isWindows = os `elem` ["windows", "mingw32", "cygwin32"]
 
 %foreign "C:idris2_getNProcessors, libidris2_support, idris_support.h"
-         "node:lambda:() => require('os').cpus().length"
+         "node:support"
 prim__getNProcessors : PrimIO Int
 
 ||| Get the number of processors on the system. Returns `Nothing` if we somehow