History

bors[bot] 5a3bae7be5 Merge #220 220: Drop flattenTreeSystem and use custom function for filtering packages r=nrdxp a=Pacman99 I don't think we should flatten the system because if a user doesn't make a package a derivation in pkgs/default.nix we should trust that there is a reason for doing so. So instead this drops the flattenTreeSystem reference(and switches to flake-utils master branch) and replaces its usage with a custom function `filterPackages`. This function filter all packages that match three conditions; - is a derivation - not broken - system is supported In that order as to not cause errors when trying to reference non-derivation meta attributes. And then also just dump all packages into legacy packages, so everything else is still accessible. I was considering removing the packages that are already in the packages output in legacyPackages, but I don't think its necessary since nix looks to the packages output first. Co-authored-by: Pacman99 <pachum99@gmail.com>		2021-03-27 00:10:58 +00:00
..
devos	Merge #211	2021-03-26 21:22:49 +00:00
attrs.nix	Merge #220	2021-03-27 00:10:58 +00:00
default.nix	lib/filterPackages: filter by flake requirements	2021-03-26 16:55:27 -07:00
lists.nix	lib/pathsIn: don't error if path doesn't exist	2021-03-25 15:21:10 -07:00
README.md	lib: add usage docs	2021-03-01 14:37:43 -05:00
strings.nix	lib: add rgxToString function	2021-03-14 21:40:49 -06:00

README.md

Lib

The lib directory mirrors the upstream concepts of nixpkgs:./lib, nixpkgs:./nixos/lib and nixpkgs:./pkgs/pkgs-lib, but also occasionally nixpkgs:./pkgs/build-support.

It comes with functions necesary to declutter devos itself, but you are welcome to extend it to your needs.

For example:

you want to add a library function that depends on some packages and use it throughout your devos environment: place it into ./lib as if you would place it into nixpkgs:./pkgs/pkgs-lib.
you want to add library functions that don't depend on pkgs: place them into ./lib as if you would place them into nixpkgs:./lib.
need to try out a newish custom build support: place it here before upstreaming into nixpkgs:./pkgs/build-support.
you want to reutilize certain module configuration functions or helpers: place them into ./lib as if you would place them into nixpkgs:./nixos/lib.

Once your library grows, we recoomend you start organizing them into subfolders analogous nixpkgs:

`nixpkgs`	`devos`
`./lib`	`./lib`
`./pkgs/pkgs-lib`	`./lib/pkgs-lib`
`./nixos/lib`	`./lib/nixos-lib`
`./pkgs/build-support`	`./lib/pkgs-build`

Example

lib/nixos-lib/mkCustomI3BindSym/default.nix:

{ pkgs, writers, ... }:
{ name, cmd, workspace, baseKey }:
let
  isWorkspaceEmpty = writers.writePython3 "is-workspace-empty" {
    libraries = [ pkgs.python3Packages.i3ipc ];
  } (builtins.readFile ./is-workspace-empty.py);

  ws = builtins.toString workspace;
in
''

  # ${name}
  #bindsym ${baseKey}+${ws} workspace ${ws}; exec ${cmd}
  bindsym ${baseKey}+${ws} workspace ${ws}; exec bash -c "${isWorkspaceEmpty} && ${cmd}"
''

lib/nixos-lib/mkCustomI3BindSym/is-workspace-empty.py:

# returns 0/1 if current workspace is empty/non-empty

import i3ipc

i3 = i3ipc.Connection()
tree = i3.get_tree()


def current_workspace():
    return tree.find_focused().workspace()


if current_workspace().leaves():
    print("Error current workspace is not empty")
    exit(1)
exit(0)

lib/default.nix:

{ nixos, pkgs, ... }:
# ...
{
  # ...
  mkCustomI3BindSym = pkgs.callPackage ./nixos-lib/mkCustomI3BindSym { };
}