yarnInstallHook: init (#328544)

- `yarnConfigHook`: Fetches the dependencies from the offline cache and installs them into `node_modules`.

- `yarnBuildHook`: Runs `yarn build` or a specified `yarn` command that builds the project.

- `yarnInstallHook`: Runs `yarn install --production` to prune dependencies and installs the project into `$out`.

An example usage of the above attributes is:

  nativeBuildInputs = [

    yarnConfigHook

    yarnBuildHook

    yarnInstallHook

    # Needed for executing package.json scripts

    nodejs

    npmHooks.npmInstallHook

  ];

  meta = {

})

```

Note that there is no setup hook for installing yarn based packages - `npmHooks.npmInstallHook` should fit most cases, but sometimes you may need to override the `installPhase` completely.

#### `yarnConfigHook` arguments {#javascript-yarnconfighook}

By default, `yarnConfigHook` relies upon the attribute `${yarnOfflineCache}` (or `${offlineCache}` if the former is not set) to find the location of the offline cache produced by `fetchYarnDeps`. To disable this phase, you can set `dontYarnInstallDeps = true` or override the `configurePhase`.

- `yarnBuildScript`: Sets a different `yarn --offline` subcommand (defaults to `build`).

- `yarnBuildFlags`: Single string list of additional flags to pass the above command, or a Nix list of such additional flags.

#### `yarnInstallHook` arguments {#javascript-yarninstallhook}

To install the package `yarnInstallHook` uses both `npm` and `yarn` to cleanup project files and dependencies. To disable this phase, you can set `dontYarnInstall = true` or override the `installPhase`. Below is a list of additional `mkDerivation` arguments read by this hook:

- `yarnKeepDevDeps`: Disables the removal of devDependencies from `node_modules` before installation.

### yarn2nix {#javascript-yarn2nix}

WARNING: The `yarn2nix` functions have been deprecated in favor of the new `yarnConfigHook` and `yarnBuildHook`. Documentation for them still appears here for the sake of the packages that still use them. See also a tracking issue [#324246](https://github.com/NixOS/nixpkgs/issues/324246).

WARNING: The `yarn2nix` functions have been deprecated in favor of the new `yarnConfigHook`, `yarnBuildHook` and `yarnInstallHook`. Documentation for them still appears here for the sake of the packages that still use them. See also a tracking issue [#324246](https://github.com/NixOS/nixpkgs/issues/324246).

#### Preparation {#javascript-yarn2nix-preparation}

  stdenv,

  lib,

  makeWrapper,

  installShellFiles,

  nodejsInstallManuals,

  nodejsInstallExecutables,

  coreutils,

  nix-prefetch-git,

  fetchurl,

  jq,

  nodejs,

  nodejs-slim,

  prefetch-yarn-deps,

  fixup-yarn-lock,

      description = "Run yarn build in buildPhase";

    };

  } ./yarn-build-hook.sh;

  yarnInstallHook = makeSetupHook {

    name = "yarn-install-hook";

    propagatedBuildInputs = [

      yarn

      nodejsInstallManuals

      nodejsInstallExecutables

    ];

    substitutions = {

      jq = lib.getExe jq;

    };

  } ./yarn-install-hook.sh;

}

# shellcheck shell=bash

yarnInstallHook() {

    echo "Executing yarnInstallHook"

    runHook preInstall

    local -r packageOut="$out/lib/node_modules/$(@jq@ --raw-output '.name' ./package.json)"

    mkdir -p "$packageOut"

    local -ar yarnArgs=(

        --ignore-engines

        --ignore-platform

        --ignore-scripts

        --no-progress

        --non-interactive

        --offline

    )

    local -r tmpDir="$(mktemp -d yarnInstallHook.XXXXXX)"

    # yarn pack does not work at all with bundleDependencies.

    # Since we are imediately unpacking, we can just remove them from package.json

    # This will NOT be fixed in yarn v1: https://github.com/yarnpkg/yarn/issues/6794

    mv ./package.json "$tmpDir/package.json.orig"

    # Note: two spellings are accepted, 'bundleDependencies' and 'bundledDependencies'

    @jq@ 'del(.bundleDependencies)|del(.bundledDependencies)' "$tmpDir/package.json.orig" > ./package.json

    # TODO: figure out a way to avoid redundant compress/decompress steps

    yarn pack \

        --filename "$tmpDir/yarn-pack.tgz" \

        "${yarnArgs[@]}"

    tar xzf "$tmpDir/yarn-pack.tgz" \

        -C "$packageOut" \

        --strip-components 1 \

        package/

    mv "$tmpDir/package.json.orig" ./package.json

    nodejsInstallExecutables ./package.json

    nodejsInstallManuals ./package.json

    local -r nodeModulesPath="$packageOut/node_modules"

    if [ ! -d "$nodeModulesPath" ]; then

        if [ -z "${yarnKeepDevDeps-}" ]; then

            # Yarn has a 'prune' command, but it's only a stub that directs you to use install

            if ! yarn install \

                --frozen-lockfile \

                --force \

                --production=true \

                "${yarnArgs[@]}"

            then

              echo

              echo

              echo "ERROR: yarn prune step failed"

              echo

              echo 'If yarn tried to download additional dependencies above, try setting `yarnKeepDevDeps = true`.'

              echo

              exit 1

            fi

        fi

        find node_modules -maxdepth 1 -type d -empty -delete

        cp -r node_modules "$nodeModulesPath"

    fi

    runHook postInstall

    echo "Finished yarnInstallHook"

}

if [ -z "${dontYarnInstall-}" ] && [ -z "${installPhase-}" ]; then

    installPhase=yarnInstallHook

fi

{

  stdenvNoCC,

  lib,

  buildNpmPackage,

  fetchFromGitHub,

  fetchYarnDeps,

  yarnConfigHook,

  yarnBuildHook,

  yarnInstallHook,

  nodejs,

  nix-update-script,

  testers,

  writeText,

  runCommand,

  blade-formatter,

  nodejs,

}:

buildNpmPackage rec {

stdenvNoCC.mkDerivation (finalAttrs: {

  pname = "blade-formatter";

  version = "1.41.1";

  src = fetchFromGitHub {

    owner = "shufo";

    repo = "blade-formatter";

    rev = "v${version}";

    rev = "v${finalAttrs.version}";

    hash = "sha256-iaWpIa+H+ocAXGc042PfmCu9UcJZeso9ripWB2/1oTs=";

  };

  postPatch = ''

    cp ${./package-lock.json} ./package-lock.json

  '';

  yarnOfflineCache = fetchYarnDeps {

    yarnLock = finalAttrs.src + "/yarn.lock";

    hash = "sha256-zn0PgLIWk23EhYeOKF2RkpvLOusVrqoBazKcJpIAzm8=";

  };

  npmDepsHash = "sha256-wEz0DTbg+Fdmsf0Qyeu9QS+I8gkPJeaJC/3HuP913og=";

  nativeBuildInputs = [

    yarnConfigHook

    yarnBuildHook

    yarnInstallHook

    nodejs

  ];

  passthru = {

    updateScript = ./update.sh;

    updateScript = nix-update-script { };

    tests = {

      version = testers.testVersion {

        package = blade-formatter;

    mainProgram = "blade-formatter";

    inherit (nodejs.meta) platforms;

  };

}

})