Add template for Node.js

[DrSensor]

Programming language JavaScript and Typescript

Toolchains

Static Code Analysis a.k.a linter

• eslint or gts or esprint (choose one)
• Linting your TypeScript Codebase with ESLint

Code Formatter

prettier or gts

Update Dependencies

• npm
• node2nix (it's slow! both download and unpacking are not in parallel)

  npm install --package-lock-only
  node2nix --lock package-lock.json

  https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/javascript.section.md

Security Audit

npm audit

npm audit

Others

• bytenode - compile scripts into V8 bytecode
• nodec - compile scripts into single executable (crosstool-ng needed for cross compilation ⚠)
• tscc - as bundler and minifier

[DrSensor]

Draft

{
        javascript-node-env = {
          mkShell =
            { src ? ./.
            , lockfile ? src + "/package-lock.nix"
            , nixLock ? if hasSuffix ".nix" lockfile then lockfile else src + "/package-lock.nix"
            , yarnLock ? if hasSuffix ".lock" lockfile then lockfile else src + "/yarn.lock"
            , npmLock ? if hasSuffix ".json" lockfile then lockfile else src + "/package-lock.json"
            , pnpmLock ? if hasSuffix ".yaml" lockfile then lockfile else src + "/pnpm-lock.yaml"
            , nodejs ? pkgs.nodejs
            , ...
            }@attrs: with pkgs.lib; let
              buildNixLockCommand = lock: optionalString (isString lock) "anylock --as=nix --lockfile=${lock} --no-patch > ${nixLock}";
              mkNixLock = lock: runCommandLocal "package-lock.nix" { } (buildNixLockCommand lock);
            in
            if pathExists nixLock then
              ...
            else
              mkShell {
                packages = with pkgs.nodePackages; [ nodejs ]
                  ++ optional (hasInfix "slim" nodejs.name || lockfile == npmLock) npm
                  ++ optional (lockfile == yarnLock) yarn
                  ++ optional (lockfile == pnpmLock) pnpm
                  ++ [ anylock ];
                shellHook =
                  let
                    lockExists = lock: (lockfile == lock) && pathExists lock;
                    lockNotExists = lock: (lockfile == lock) && !(pathExists lock);
                    defaultLockfile =
                      if lockfile == npmLock then "package-lock.json" else
                      if lockfile == yarnLock then "yarn.lock" else
                      if lockfile == pnpmLock then "pnpm-lock.yaml" else
                      lockfile;
                    notExists-then = cmd: lock: optionalString (any lockNotExists (toList lock)) (cmd + "\n");
                    exists-then = cmd:
                      if isList cmd then optionalString (lockExists (last cmd)) ((concatStrings cmd) + defaultLockfile + "\n")
                      else lock: optionalString (lockExists lock) (cmd + defaultLockfile + "\n");
                  in
                  (notExists-then "npm install --package-lock-only" [ npmLock yarnLock pnpmLock ])
                    + (notExists-then "yarn import" yarnLock)
                    + (notExists-then "pnpm import" pnpmLock)
                    + (concatMapStrings (lock: exists-then [ "cp" lock ]) [ npmLock yarnLock pnpmLock ])
                    + (buildNixLockCommand defaultLockfile)
                    + (concatMapStrings (lock: exists-then "rm" lock) [ npmLock yarnLock pnpmLock ])
                    + ''git add ${lockfile}
                    echo -e "\nPlease run$(tput bold) nix develop $(tput sgr0)again."
                    exit
                  '';
              };
        };
}