path: root/org/config_nix.org

-*- mode: org -*-
#+TITLE:       configuration nix
#+DESCRIPTION: makefile for spine
#+FILETAGS:    :spine:build:tools:
#+AUTHOR:      Ralph Amissah
#+EMAIL:       [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]]
#+COPYRIGHT:   Copyright (C) 2015 - 2023 Ralph Amissah
#+LANGUAGE:    en
#+STARTUP:     content hideblocks hidestars noindent entitiespretty
#+PROPERTY:    header-args  :exports code
#+PROPERTY:    header-args+ :noweb yes
#+PROPERTY:    header-args+ :results no
#+PROPERTY:    header-args+ :cache no
#+PROPERTY:    header-args+ :padline no
#+PROPERTY:    header-args+ :mkdirp yes
#+OPTIONS:     H:3 num:nil toc:t \n:t ::t |:t ^:nil -:t f:t *:t

* nix :nix:

#+NAME: nixpkgs_local
#+BEGIN_SRC sh
/srv/nixpkgs-dev/nixpkgs
#+END_SRC

** spine markup samples

- default.nix
- shell.nix

*** envrc :envrc:
**** .envrc

- https://github.com/nix-community/nix-direnv
  - source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/${NixDirEnvVersion}/direnvrc" "sha256-0000000000000000000000000000000000000000000="

#+HEADER: :tangle ../.envrc
#+BEGIN_SRC sh
use flake .
#use flake .#default
NIX_ENFORCE_PURITY=1
NixDirEnvVersion="2.2.1"
if ! has nix_direnv_version || ! nix_direnv_version ${NixDirEnvVersion}; then
# - https://github.com/nix-community/nix-direnv
# source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/${NixDirEnvVersion}/direnvrc" "sha256-0000000000000000000000000000000000000000000="
  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/${NixDirEnvVersion}/direnvrc" "sha256-zelF0vLbEl5uaqrfIzbgNzJWGmLzCmYAkInj/LNxvKs="
fi
watch_file flake.lock
watch_file flake.nix
#nix flake update && nix flake check --show-trace && nix flake show
if [ -f .envrc-local ]; then
  source_env_if_exists .envrc-local || source .envrc-local
fi
PATH_add result/bin
# echo "
#
# - nix flake update && nix flake check --show-trace && nix flake show && nix develop .#devShell
#
# - nix build .#default --print-build-logs
# - nix build .#spine-dmd --print-build-logs
# - nix build .#spine-ldc --print-build-logs
# - nix build .#spine-gdc --print-build-logs
#
# nix-shell '<nixpkgs>' -A nix --pure
#
# nix run .#default --print-build-logs
#
# nix develop --build .#default --print-build-logs
#
# nix shell .#default --print-build-logs --command spine -v
# nix shell .#default --print-build-logs --command spine --very-verbose --epub --html --html-link-search --html-link-curate --curate --output=\"\$SpineOUT\" ./markup/pod
# nix shell .#default --print-build-logs --command spine --very-verbose --html --html-link-search --html-link-curate --curate --sqlite-update --sqlite-db-filename=\"spine.search.db\" --cgi-sqlite-search-filename=\"spine_search\" --sqlite-db-path=\"\$SpineDBpath\" --output=\"\$SpineOUT\" ./markup/pod
# "
#+END_SRC

**** .envrc-local CHECK MODIFY

- bespoke modify appropriately and generate if needed

#+HEADER: :tangle ../.envrc-local_
#+HEADER: :noweb yes
#+BEGIN_SRC sh
#export NIX_PATH=/nix/var/nix/profiles/per-user/root/channels/nixos
#export NIX_PATH=/srv/nix/nixpkgs
#export NIX_PATH=nixpkgs=/srv/nix/nixpkgs
export DFLAGS="-O2 -inline -boundscheck=on -color=on"
#export SpineBIN=result/bin
export SpinePROJ=~/grotto/repo/git.repo/projects/doc-reform/code/software/spine
export SpineDOC=.
export SpineOUT=/srv/www/spine
export SpineDBpath=/var/www/sqlite
#export SpineDBpath=/srv/www/spine/sqlite
export SpineCGIbin=/var/www/cgi/cgi-bin
export SpineSearchActionLocal='http://localhost/spine_search'
export SpineSearchActionRemote='https://sisudoc.org/spine_search'
export SpineCGIform='spine_search'
export SpineSQLdb='spine.search.db'
#+END_SRC

*** flake :flake:
**** flake static :flake:static:
***** flake.nix

#+HEADER: :tangle ../flake.nix
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{
  description                  = "spine (sisu like parser & document generator) made available to process markup samples";
  inputs = {
    nixpkgs.url                = "github:NixOS/nixpkgs/nixpkgs-unstable"; # "github:nixos/nixpkgs";
    flake-utils.url            = "github:numtide/flake-utils";
    spine.url                  = "<<spine_git_file_path_url>>";
    spine.inputs.nixpkgs.follows = "nixpkgs";
    spine.flake                = true;
  };
  outputs = { self, nixpkgs, flake-utils, spine } @inputs:
    let
      version                  = "<<spine_version_set>>";
      shell                    = ./shell.nix; # ./default.nix;
      devEnv                   = ./.envrc; # ./shell.nix; # ./default.nix;
      supportedSystems         = [ "x86_64-linux" ]; # [ "x86_64-linux" "x86_64-darwin" "aarch64-linux" "aarch64-darwin" ];
      forAllSystems            = nixpkgs.lib.genAttrs supportedSystems;
      nixpkgsFor               = forAllSystems (system: import nixpkgs { inherit system;  }); # nixpkgs instantiated for supported system types.
    in {
      packages = forAllSystems (system:
        let pkgs               = nixpkgsFor.${system};
        in {
          default              = spine.packages.${system}.default;
          spine-dmd            = spine.packages.${system}.spine-dmd;
          spine-ldc            = spine.packages.${system}.spine-ldc;
          spine-gdc            = spine.packages.${system}.spine-gdc;
          #vendorSha256         = "sha256-0Q00000000000000000000000000000000000000000=";
        });
      devShells = forAllSystems (system:
        let
          pkgs = nixpkgsFor.${system};
          shellHook = ''
            export DFLAGS="-O2 -inline -boundscheck=on -color=on"
            export Date=`date "+%Y%m%d"`
            ### set local values in .envrc-local (or modify here if you must)
            # export SpinePROJ=~/grotto/repo/git.repo/projects/doc-reform/code/software/spine
            # export SpineDOC=~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/spine-markup-samples
            # export SpineOUT=/srv/www/spine
            export SpineDBpath=/var/www/sqlite
            # export SpineDBpath=/srv/www/spine/sqlite
            export SpineSRC=$SpinePROJ/src
            export SpineBIN=$SpinePROJ/result/bin
            export SpinePOD=$SpineDOC/markup/pod
            export SpineSearchActionLocal='http://localhost/spine_search'
            export SpineSearchActionRemote='https://sisudoc.org/spine_search'
            export SpineCGIform='spine_search'
            export SpineSQLdb='spine.search.db'
            export spineNixHelp="cat ./.env/nix-commands"
            export spineTest="nix shell .#default --print-build-logs --command spine --very-verbose --epub --html --html-link-search --html-link-curate --curate --output=\"\$SpineOUT\" $SpinePOD/*"
            export spineHtml="spine --very-verbose --html --html-link-search --html-link-curate --curate --sqlite-update --sqlite-db-filename=\"spine.search.db\" --cgi-sqlite-search-filename=\"spine_search\" --sqlite-db-path=\"\$SpineDBpath\" --output=\"\$SpineOUT\" $SpinePOD/*"
            export spineEpub="spine --very-verbose --epub --output=\"\$SpineOUT\" $SpinePOD/*"
            export spineLatex="spine --very-verbose --latex --output=\"\$SpineOUT\" $SpinePOD/*"
            export spinePdf="spine --very-verbose --pdf --output=\"\$SpineOUT\" $SpinePOD/*"
            export spineSqliteCreateDB="spine --very-verbose --sqlite-db-recreate --sqlite-db-path=\"$SpineDBpath\" --sqlite-db-filename=\"spine.search.db\""
            export spineSqlite="spine --very-verbose --sqlite-discrete --sqlite-db-path=\"$SpineDBpath\" --sqlite-db-filename=\"spine.search.db\" --output=\"\$SpineOUT\" $SpinePOD/*"
            #export spineSqlite="spine --very-verbose --sqlite-update --sqlite-db-path=\"$SpineDBpath\" --sqlite-db-filename=\"spine.search.db\" --output=\"\$SpineOUT\" $SpinePOD/*"
          '';
        in with pkgs; {
          devShell = mkShell rec {
            name = "spine base dev shell";
            inherit shell;
            inherit devEnv;
            #buildInputs        = [ sqlite ];
            #nativeBuildInputs  = [ dub dmd ldc gdc gnumake ];
            packages     = [
              dub dmd ldc gdc gnumake
              sqlite
            ];
            inherit shellHook;
          };
          devShell-epub = mkShell rec {
            name = "spine dev shell for epub output";
            inherit shell;
            inherit devEnv;
            packages     = [
              dub dmd ldc gdc gnumake
              sqlite
              libxml2
              html-tidy
              xmlstarlet
              epubcheck
              ebook_tools
              libxml2
              html-tidy
              xmlstarlet
              epubcheck
              ebook_tools
              epr
              sigil
              calibre #(suite includes: ebook-viewer)
              foliate
            ];
            inherit shellHook;
          };
          devShell-html = mkShell rec {
            name = "spine dev shell for latex & pdf output";
            inherit shell;
            inherit devEnv;
            packages     = [
              dub dmd ldc gdc gnumake
              sqlite
            ];
            inherit shellHook;
          };
          devShell-latex-pdf = mkShell rec {
            name = "spine dev shell for latex & pdf output";
            inherit shell;
            inherit devEnv;
            packages     = [
              dub dmd ldc gdc gnumake
              sqlite
              source-sans-pro
              source-serif-pro
              source-code-pro
              texlive.combined.scheme-full
            ];
            inherit shellHook;
          };
          devShell-sqlite = mkShell rec {
            name = "spine dev shell for latex & pdf output";
            inherit shell;
            inherit devEnv;
            packages     = [
              dub dmd ldc gdc gnumake
              sqlite
            ];
            inherit shellHook;
          };
          devShell-i18n = mkShell {
            inherit shell;
            inherit devEnv;
            packages     = [
              dub dmd ldc gdc gnumake
              sqlite
              perl534Packages.Po4a
            ];
            inherit shellHook;
          };
          default = import ./shell.nix { inherit pkgs; };
      });
  };
}
#+END_SRC

*** flake :flake:
**** notes?

- flake.nix
    /srv/nix/nixpkgs
    ./shell.nix
  - shell.nix
      ./pkgs/shell-pkgs.nix
    - pkgs/shell-pkgs.nix
  - default.nix
     ./nix/dub.selections.nix #
    - dub.selections.nix

- nix develop

- nix flake update

- nix shell -f default.nix --print-build-logs
- nix shell -c default.nix

- nix build `nix-instantiate`
- nix build -f default.nix --print-build-logs
- nix shell -f default.nix --print-build-logs
- nix develop --build -f derivation.nix -I .envrc --print-build-logs
- nix develop --profile .#default --print-build-logs --command spine -v

- nix search --json 2>/dev/null |jq
- nix flake show
- nix show-derivation

nix shell git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine  --print-build-logs
nix build "git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine" --print-build-logs
nix develop 'git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine#default'
nix flake clone git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine/

# nix-instantiate | nix-build

***** flake inputs
****** flake inputs static

#+NAME: flake_inputs_nix
#+HEADER: :noweb yes
#+BEGIN_SRC nix
nixpkgs.url          = "github:nixos/nixpkgs";
flake-utils.url      = "github:numtide/flake-utils";
#+END_SRC

#+NAME: flake_inputs_spine
#+HEADER: :noweb yes
#+BEGIN_SRC nix
spine.url          = "git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine";
spine.flake        = true;
#+END_SRC

***** flake outputs
****** flake outputs static

#+NAME: flake_outputs
#+HEADER: :noweb yes
#+BEGIN_SRC nix
self, nixpkgs, flake-utils
#+END_SRC

***** flake devshells

#+NAME: flake_devshells
#+HEADER: :noweb yes
#+BEGIN_SRC nix
devShells               = forAllSystems (system:
  let pkgs              = nixpkgsFor.${system};
  in {
    default = pkgs.mkShell {
      buildInputs       = with pkgs; [ git dub dmd ldc sqlite ];
    };
});
#+END_SRC

***** flake output default

#+NAME: flake_output_default
#+HEADER: :noweb yes
#+BEGIN_SRC nix
packages.x86_64-linux.default = self.packages.x86_64-linux.spine;
#+END_SRC

#+NAME: flake_output_spine
#+HEADER: :noweb yes
#+BEGIN_SRC nix
packages.x86_64-linux.spine = spine.packages.x86_64-linux.default;
#+END_SRC

#+NAME: flake_output_spine_tarball
#+HEADER: :noweb yes
#+BEGIN_SRC nix
packages.x86_64-linux.spine-tarball = spine-tarball.packages.x86_64-linux.default;
#+END_SRC

**** flake result/lib/spine-markup-samples

#+NAME: flake_output_spine_markup_samples
#+HEADER: :noweb yes
#+BEGIN_SRC nix
packages.x86_64-linux.spine-markup-samples =
  let
    pkgs            = import nixpkgs {
      system        = "x86_64-linux";
    };
  in
    pkgs.stdenv.mkDerivation {
      pname         = "spine-markup-samples";
      version       = "<<spine_version_set>>";
      description   = "markup samples for spine, a sisu like parser & document generator";
      inherit self;
      src           = self;
      shell         = ./shell.nix;
      buildPhase    = ''
        runHook preBuild
        HOME="$PWD"
        runHook postBuild
      '';
      checkPhase    = ''
        runHook preCheck
        HOME="$PWD"
        runHook postCheck
      '';
      installPhase  = ''
        runHook preInstall
        mkdir -p $out/lib/spine-markup-samples
        echo "pwd: $PWD"
        cp -rv ./markup $out/lib/spine-markup-samples/.
        runHook postInstall
      '';
    };
#+END_SRC

postInstall = ''
  #${spine} -v
  #echo "built:"
  #$out/share/spine-markup-samples
'';

***** flake misc

#+BEGIN_SRC nix
inputs.spine.url = fetchTarball {
  url       = "<<spine_tarball_path_url>>";
  sha256    = "<<spine_tarball_sha256>>";
};
#+END_SRC

*** shell.nix :shell:
**** tangle

#+HEADER: :tangle ../shell.nix
#+HEADER: :tangle-mode (identity #o755)
#+HEADER: :shebang "#!/usr/bin/env -S nix-shell --pure\n#!nix-shell -i bash"
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {} }:
with pkgs;
mkShell {
  buildInputs = [
    ### nix_related
    # direnv
    # nixVersions.unstable #nixFlakes
    # nix-prefetch-git
    # validatePkgConfig
    # nix-tree jq nix-output-monitor
    # git
    # ps
    ### d_build_related
    ### package manager
    # dub
    ### compiler
    # ldc
    # rund
    ### linker
    # #lld
    # #mold
    ## builder
    # #ninja
    # #meson
    ### sqlite search related
    # sqlite
    ### pdf_latex_related
    # source-sans-pro
    # source-serif-pro
    # source-code-pro
    # texlive.combined.scheme-full
    ### xml_and_epub_related
    # libxml2
    # html-tidy
    # xmlstarlet
    # epubcheck
    # ebook_tools
    # epr
    # sigil
    # calibre #(suite includes: ebook-viewer)
    # foliate
    ### i18n translation related
    # perl534Packages.Po4a
  ];
  shellHook = ''
    #if [[ -f ".envrc" ]]; then
    #  source .envrc
    #fi
    #nix flake update
    #echo ""
    #echo "nix flake metadata:"
    #nix flake metadata
    #echo ""
    #echo "nix flake check:"
    #nix flake check
    #echo ""
    #echo "nix flake show:"
    #nix flake show
    echo "
      nix flake update
      nix flake metadata
      nix flake check
      nix flake show

      nix build or nix develop? (suggestions):

      - nix build
        nix build .#default --print-build-logs
        nix build .#default-tarball --print-build-logs
        nix build .#default-markup-samples --print-build-logs
        nix build --print-build-logs
        nix build .#default --print-build-logs |& nom

      - nix run
        nix run .#default --print-build-logs
        nix run default.nix --print-build-logs

      - nix shell
        nix shell .#default --print-build-logs --command spine -v

      - nix develop
        nix develop --build .#default --print-build-logs
        nix develop --build -f derivation.nix -I .envrc --print-build-logs
        nix develop ; eval \$buildPhase

        nix-build |& nom

      spine -v

      nix-instantiate | nix show-derivation | jq
      nix-build . --no-out-link | xargs -o nix-tree
      nix-tree --derivation .#default

    "
  '';
}
#+END_SRC

**** Notes

#+BEGIN_SRC text
#% Notes

# - shell.nix -I .envrc
# - shell.nix -I .envrc --pure

# [ nix-shell ]

  # - nix-shell -I nixpkgs=/nixpkgs-ra/nixpkgs --pure
  # - nix-shell -p "with import /nixpkgs-ra/nixpkgs {}; ldc" --pure
  # - nix-shell -p "with import /nixpkgs-ra/nixpkgs {}; [dub ldc]" --pure

  # - nix-shell -p nixFlakes
  # - nix-shell -p nixFlakes --pure
  # - nix-shell -p nixFlakes --pure -p "with import /nixpkgs-ra/nixpkgs {}; [nix dub ldc git ps]"
  # - nix-shell shell.nix direnv: export +IN_NIX_SHELL
  # - nix-shell shell.nix

# [ nix-build ]

  # - nix-build -I nixpkgs=/nixpkgs-ra/nixpkgs # --pure
  # - nix-build -I .envrc --pure
  # - nix-build default.nix -I .envrc && result/bin/spine -v

# [ nix-instantiate ]

  # - nix-instantiate | nix show-derivation | jq
  # - nix-instantiate -I .envrc | nix show-derivation -f derivation.nix -I .envrc | jq
  # - nix-instantiate | nix show-derivation --recursive | jq
  # - nix-instantiate -I .envrc | nix show-derivation -f derivation.nix --recursive -I .envrc | jq
  # - nix-instantiate | nix-build
  # - nix-instantiate -I .envrc | nix-build -I .envrc

# [ nix shell ]

  # - nix shell -c default.nix
  # - nix shell -f default.nix --print-build-logs

# [ nix build ]

  # - nix build -I .envrc --print-build-logs
  # - nix build -f default.nix --print-build-logs
  # - nix build -f derivation.nix --print-build-logs

  # - nix build `nix-instantiate`
  # - nix build `nix-instantiate -I .envrc`

  # - nix build -f default.nix && ./result/bin/spine -v && noti -t "spine build" -m "see ./result/bin/spine"
  # - nix build .#default

# [ nix run ]

  # - nix run default.nix --print-build-logs
  # - nix run -I .envrc default.nix --print-build-logs
  # - nix run .#default

# - nix-shell -I .envrc --pure
# - nix develop --build -f derivation.nix -I .envrc --print-build-logs

# - nix-shell -p nixFlakes --pure -p "with import /nixpkgs-ra/nixpkgs {}; [nix dub ldc git ps]"
# - nix-build
# - nix build `nix-instantiate -I .envrc`

# - nix develop --build -f default.nix -I .envrc

# - nix-shell -I .envrc --pure
# - nix-build default.nix -I .envrc && result/bin/spine -v

# - nix shell -f default.nix --print-build-logs
# - nix-instantiate -I .envrc | nix-build -I .envrc
#+END_SRC

*** default.nix :default:

- default.nix -I nixpkgs=<provide local nix path>
  e.g. default.nix -I nixpkgs=/nixpkgs-ra/nixpkgs

- nix-build -I nixpkgs=<provide local nix path>
  e.g. nix-build -I nixpkgs=<<nixpkgs_local>>

#+HEADER: :noweb yes
#+BEGIN_SRC sh
nix-build -I nixpkgs=<<nixpkgs_local>>
nix-build -I .envrc-local
nix-build -I .envrc
default.nix -I .envrc
default.nix

nix build -f default.nix --print-build-logs
nix build -f derivation.nix --print-build-logs
nix shell -f default.nix --print-build-logs
nix develop --build -f derivation.nix -I .envrc --print-build-logs

# nix build -f project.nix
# nix build -f spine.nix
#+END_SRC

#+HEADER: :tangle ../default.nix
#+HEADER: :tangle-mode (identity #o755)
#+HEADER: :shebang "#!/usr/bin/env -S nix-build"
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {} }:
pkgs.callPackage ./derivation.nix {}
#+END_SRC

*** derivation.nix :default:

#+HEADER: :tangle ../derivation.nix
#+HEADER: :tangle-mode (identity #o644)
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {},
  stdenv ? pkgs.stdenv,
  lib ? pkgs.lib,
  ldc ? null,
  dcompiler ? pkgs.ldc,
  dub ? pkgs.dub
}:
assert dcompiler != null;
with (
  with lib;
  let
    filterDub = name: type: let baseName = baseNameOf (toString name); in ! ( # filter function to remove the .dub package folder from src
      type == "directory" && baseName == ".dub"
    );
    targetOf = package: "${package.targetPath or "."}/${package.targetName or package.name}";
    # remove reference to build tools and library sources
    disallowedReferences = deps: [ dcompiler dub ];
    removeExpr = refs: ''remove-references-to ${lib.concatMapStrings (ref: " -t ${ref}") refs}'';
  in {
    mkDubDerivation = lib.makeOverridable ({
      src,
      nativeBuildInputs ? [],
      dubJSON ? src + "/dub.json",
      passthru ? {},
      package ? lib.importJSON dubJSON,
      ...
    } @ attrs: stdenv.mkDerivation (attrs // {
      pname = package.name;
      nativeBuildInputs = [ dcompiler dub pkgs.removeReferencesTo ] ++ nativeBuildInputs;
      disallowedReferences = disallowedReferences deps;
      passthru = passthru // {
        inherit dub dcompiler pkgs;
      };
      src = lib.cleanSourceWith {
        filter = filterDub;
        src = lib.cleanSource src;
      };
      preFixup = ''
        find $out/bin -type f -exec ${removeExpr (disallowedReferences deps)} '{}' + || true
      '';
      buildPhase = ''
        runHook preBuild
        HOME="$PWD"
        DFLAGS="-O2 -inline"
        for DC_ in dmd ldmd2 gdmd; do
          echo "- check for D compiler $DC_"
          DC=$(type -P $DC_ || echo "")
          if [ ! "$DC" == "" ]; then
            break
          fi
        done
        if [ "$DC" == "" ]; then
          exit "Error: could not find D compiler"
        fi
        echo "$DC_ used as D compiler to build $pname"
        dub build --compiler=$DC --build=release --combined --skip-registry=all
        runHook postBuild
      '';
      checkPhase = ''
        runHook preCheck
        HOME="$PWD"
        dub test --combined --skip-registry=all
        runHook postCheck
      '';
      installPhase = ''
        runHook preInstall
        mkdir -p $out/bin
        cp -r "${targetOf package}" $out/bin
        #cp -rv "${targetOf package}" $out/spine-markup-samples/.
        #cp -rv ./markup $out/spine-markup-samples/.
        runHook postInstall
      '';
      #postInstall= ''
      #  cp -rv ./markup $out/spine-markup-samples/.
      #'';
      meta = lib.optionalAttrs (package ? description) {
        description = package.description;
      } // attrs.meta or {};
    } // lib.optionalAttrs (!(attrs ? version)) {
      name = package.name; # use name from dub.json, unless pname and version are specified
    }));
  }
);
mkDubDerivation rec {
  pname         = "spine";
  version       = "0.12.0";
  zipfile       = "<<spine_tarball_filename>>";
  src = fetchTarball {
    #url         = "file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/tarball/${pname}-${version}.tar.gz";
    #url         = "file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine/tarballGitHEAD/${pname}-${version}.tar.gz";
    #sha256      = "sha256:0000000000000000000000000000000000000000000000000000";
    url         = "<<spine_tarball_path_url>>";
    sha256      = "<<spine_tarball_sha256>>";
  };
  nativeBuildInputs = with pkgs; [ dub ldc ];
  buildInputs = with pkgs; [
    nixVersions.unstable #nixFlakes
    sqlite
  ];
  meta = with pkgs.lib; {
    description = "A sisu like parser & document generator";
    longDescription = ''
      a sisu like parser & document generator
    '';
    homepage    = "https://sisudoc.org";
    license     = licenses.agpl3Plus;
    platforms   = platforms.linux;
    maintainers = [ "RalphAmissah" ];
  };
}
#+END_SRC

# src = fetchTarball {
#   url          = "file:///[path]/${pname}-${version}.tar.gz";
#   sha256       = "sha256:0000000000000000000000000000000000000000000000000000";
# };

#src           = ./.;

** variables
*** spine version SET VERSION :version:set:project:

#+NAME: spine_version_set
#+BEGIN_SRC sh
0.12.0
#+END_SRC

#+NAME: project_path_local_out_static
#+HEADER: :noweb yes
#+BEGIN_SRC nix
/srv/www/spine
#+END_SRC

#+NAME: spine_tarball_path
#+HEADER: :noweb yes
#+BEGIN_SRC nix
/home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/tarball
#+END_SRC

#+NAME: spine_tarball_path_url
#+HEADER: :noweb yes
#+BEGIN_SRC nix
file://<<spine_tarball_path>>/<<spine_tarball_filename>>
#+END_SRC

#+NAME: spine_git_file_path
#+HEADER: :noweb yes
#+BEGIN_SRC nix
/home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/spine
#+END_SRC

#+NAME: spine_git_file_path_url
#+HEADER: :noweb yes
#+BEGIN_SRC nix
git+file://<<spine_git_file_path>>
#+END_SRC

#+NAME: spine_tarball_filename
#+HEADER: :noweb yes
#+BEGIN_SRC nix
spine-0.12.0-tag-0.11.2.r107.gf89a107.tar.gz
#+END_SRC

#+NAME: spine_tarball_sha256
#+HEADER: :noweb yes
#+BEGIN_SRC nix
sha256:03dr7dn7kq6arw4ry7qar13iqmi1caw70imfjwi8qr7g2j4mnk2q
#+END_SRC

#+BEGIN_SRC nix
sha256:0000000000000000000000000000000000000000000000000000
#+END_SRC

/home/ralph/grotto/repo/git.repo/projects/project-spine/tarball

#+NAME: project_path_local_out_static_
#+BEGIN_SRC nix
/var/www
#+END_SRC

#+NAME: project_path_sqlite
#+BEGIN_SRC nix
/var/www/sqlite
#+END_SRC

#+NAME: nixpkgs_url
#+BEGIN_SRC nix
github:nixos/nixpkgs
#+END_SRC

#+HEADER: :noweb yes
#+BEGIN_SRC nix
<<nixpkgs_path_local>>
#+END_SRC

**** .env/echo-nixNote CHECK MODIFY

#+HEADER: :tangle ../.env/nix-commands
#+BEGIN_SRC text
- nix flake update && nix flake check --show-trace && nix flake show && nix develop .#devShell

- nix build .#default --print-build-logs
- nix build .#spine-dmd --print-build-logs
- nix build .#spine-ldc --print-build-logs
- nix build .#spine-gdc --print-build-logs

- nix develop
  - nix develop .#devShell --print-build-logs
  - nix develop .#devShell-html --print-build-logs
  - nix develop .#devShell-epub --print-build-logs
  - nix develop .#devShell-latex-pdf --print-build-logs
  - nix develop .#devShell-sqlite --print-build-logs
  - nix develop .#devShell-i18n --print-build-logs

nix run .#default --print-build-logs

nix develop --build .#default --print-build-logs

nix-shell '<nixpkgs>' -A nix --pure
#+END_SRC

#+HEADER: :tangle ../.env/echo-nixNote
#+BEGIN_SRC sh
echo '-*- mode: org -*-

,* nixpkgs path?

  # eval "$(nix print-dev-env)"
' > nixNote_.org

echo "  <nixpkgs> == `nix-instantiate --find-file nixpkgs`" >> nixNote_.org

echo '
,* nix build and show derivation

,#+BEGIN_SRC sh
nix-shell --pure

nix-build
nix build -f default.nix --print-build-logs
nix shell -f default.nix --print-build-logs
nix develop --build -f derivation.nix -I .envrc --print-build-logs

nix-instantiate | nix-build

nix-instantiate -I .envrc | nix-build -I .envrc
nix build `nix-instantiate`
nix build `nix-instantiate -I .envrc`

nix develop

nix-instantiate | nix show-derivation | jq
nix-instantiate -I .envrc | nix show-derivation -f derivation.nix -I .envrc | jq

nix-instantiate | nix show-derivation --recursive | jq
nix-instantiate -I .envrc | nix show-derivation -f derivation.nix --recursive -I .envrc | jq

nix search --json 2>/dev/null |jq
,#+END_SRC

,* version and build info

,#+BEGIN_SRC sh' >> nixNote_.org

echo 'spine version (git) == $SpineVER' >> nixNote_.org
echo "spine version (git) == $SpineVER" >> nixNote_.org
echo 'nix-instantiate == `nix-instantiate`' >> nixNote_.org
echo "nix-instantiate == `nix-instantiate`" >> nixNote_.org

echo "#+END_SRC

,* initialised shell variables

,#+BEGIN_SRC sh
SpineSRC=$SpineSRC
SpineDOC=$SpineDOC
SpinePOD=$SpinePOD
SpineOUTversioned=$SpineOUTversioned
SpineOUT=$SpineOUT
,#+END_SRC
" >> nixNote_.org

echo '* spine run instruction examples
,** parallelized tasks
,*** doc source

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --pod --source --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** html & epub output

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --html --epub --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** sqlite db for each document - populate each db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** doc source; html, epub; sqlite outputs

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --pod --html --epub --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** curate (authors topics)

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --curate --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** html, curate

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --dark --html --html-link-curate --curate --output="$SpineOUTversioned" $SpinePOD/*
$SpineBIN/spine --very-verbose --html --html-link-curate --curate --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** composite command: source pod, html, epub, curate, sqlite

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --dark --pod --epub --html --html-link-curate --curate --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,** sequential tasks
,*** sqlite db (shared) - create db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUTversioned"
,#+END_SRC

,*** sqlite db (shared) - populate db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUTversioned" $SpineDOC/spine-markup-samples/markup/pod/*
,#+END_SRC

,*** sqlite db (shared) - drop db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-drop --output="$SpineOUTversioned"
,#+END_SRC

,*** sqlite db (shared) - create & populate db (single step)

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-create --sqlite-update --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** composite command: source pod, html, epub, curate, sqlite

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --no-parallel --dark --pod --epub --html --html-link-curate --curate --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,** config [./pod/].dr/config_local_site

,#+BEGIN_SRC sh
cat $SpinePOD/.dr/config_local_site
$SpineBIN/spine --show-config $SpinePOD
$SpineBIN/spine --show-config --output="$SpineOUTversioned" $SpinePOD
,#+END_SRC

,** cgi operations (output to $SpineOUT /var/www)

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUT" $SpinePOD/*

$SpineBIN/spine -v --cgi-search-form-codegen --output=$SpineOUT $SpinePOD/*

$SpineBIN/spine -v --show-config --config=$SpinePOD/.dr

$SpineBIN/spine --html $SpinePOD/*


$SpineBIN/spine -v --cgi-search-form-codegen --config=$SpinePOD/.dr/config_local_site
,#+END_SRC

,*** generate html linked to search form

,#+BEGIN_SRC sh
$SpineBIN/spine -v --html --html-link-search --html-link-curate --curate  --output=$SpineOUT $SpinePOD/*
,#+END_SRC

,*** create or re-create sql db (--sqlite-db-create or --sqlite-db-recreate)

,#+BEGIN_SRC sh
$SpineBIN/spine -v --sqlite-db-create --sqlite-db-filename="<<spine_search_db>>" --sqlite-db-path="$SpineDBpath"
$SpineBIN/spine -v --sqlite-db-recreate --sqlite-db-filename="<<spine_search_db>>" --sqlite-db-path="$SpineDBpath"
,#+END_SRC

,*** populate sqlite db

,#+BEGIN_SRC sh
$SpineBIN/spine -v --sqlite-update --sqlite-db-filename="<<spine_search_db>>" --output=$SpineOUT $SpinePOD/*
,#+END_SRC

,*** generate html (linked to search form), sql output, curate COMPOSITE

,#+BEGIN_SRC sh
$SpineBIN/spine -v --html --html-link-search --html-link-curate --curate --sqlite-update --sqlite-db-filename="<<spine_search_db>>" --cgi-sqlite-search-filename="<<spine_search_cgi>>" --sqlite-db-path="$SpineDBpath" --output="$SpineOUT" $SpinePOD/*
$SpineBIN/spine --epub --html --html-link-search --html-link-curate --curate --sqlite-update --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine_search" --cgi-url-action="https://sisudoc.org/spine_search" --ouput="$SpineOUT" $SpinePOD/*
,#+END_SRC

,*** generate html (linked to search form), sql output, curate COMPOSITE with resource configuration

if names and paths are configured in resource configuration file, e.g. $SpinePOD/.rc/config_local_site

,#+BEGIN_SRC sh
$SpineBIN/spine -v --html --html-link-search --html-link-curate --curate --sqlite-update $SpinePOD/*
,#+END_SRC

,#+BEGIN_SRC yaml
# sample resource configuration file ( $SpinePOD/.rc/config_local_site )
output:
  path:                        "/srv/www/spine"
default:
  language:                    "en"
  papersize:                   "a4"
  text_wrap:                   "80"
  digest:                      "sha256"
webserv:
  http:                        "http"
  domain:                      "localhost"
  data_http:                   "http"
  data_domain:                 "localhost"
  data_root_url:               "https://sisudoc.org"
  data_root_path:              "/srv/www/spine"
  images_root_part:            "image"
  cgi_search_form_title:       "≅ SiSU Spine search"
  cgi_http:                    "https"
  cgi_domain:                  "sisudoc.org"
  cgi_bin_url:                 "http://sisudoc.org/cgi-bin"
  cgi_bin_part:                "cgi-bin"
  cgi_bin_path:                "/var/www/cgi/cgi-bin"
  cgi_search_script:           "<<spine_search_cgi>>"
  cgi_action:                  "https://sisudoc.org/spine_search"
  db_sqlite_filename:          "<<spine_search_db>>"
  db_sqlite_path:              "/var/www/sqlite"
,#+END_SRC

,*** make search form

,#+BEGIN_SRC sh
$SpineBIN/spine -v --cgi-search-form-codegen --config=$SpinePOD/.dr/config_local_site
,#+END_SRC

,*** latex

,#+BEGIN_SRC sh
$SpineBIN/spine --latex --serial --output="$SpineOUT" $SpinePOD/*
ls $SpineOutstatic/latex/*.tex
,#+END_SRC
' >> nixNote_.org

#cat nixNote_.org

#echo "emacs nixNote_.org"
#echo "cat nixNote_.org"
#+END_SRC