mirror of
https://github.com/dwinkler1/np.git
synced 2026-02-19 22:40:57 -05:00
Add comprehensive inline documentation to all modules and enhance README
Co-authored-by: dwinkler1 <22460147+dwinkler1@users.noreply.github.com>
This commit is contained in:
parent
c19248f706
commit
40095ac868
13 changed files with 587 additions and 32 deletions
|
|
@ -1,5 +1,24 @@
|
|||
# Utility and common host configurations
|
||||
#
|
||||
# This module defines general-purpose commands and utilities.
|
||||
# These commands are available regardless of enabled languages.
|
||||
#
|
||||
# Available commands:
|
||||
# - <name>: Launch Neovim editor (default command)
|
||||
# - <name>-g: Launch Neovide (GUI for Neovim)
|
||||
# - <name>-initProject: Initialize project directory structure
|
||||
# - <name>-updateDeps: Update all dependencies (R, Python, Julia, flake)
|
||||
# - <name>-initDevenv: Initialize devenv project (if enabled)
|
||||
# - <name>-devenv: Run devenv commands (if enabled)
|
||||
# - <name>-activateDevenv: Activate devenv shell (if enabled)
|
||||
#
|
||||
# Note: node, perl, ruby are also available but have minimal configuration
|
||||
#
|
||||
# Dependencies: neovide, devenv (if enabled), project scripts
|
||||
config: pkgs: {
|
||||
# g: Neovide - GUI frontend for Neovim
|
||||
# Provides smooth scrolling, animations, and GUI features
|
||||
# Automatically connects to the configured Neovim instance
|
||||
g = {
|
||||
enable = true;
|
||||
path = {
|
||||
|
|
@ -11,6 +30,10 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# initProject: Initialize research project structure
|
||||
# Creates standardized directory layout for data analysis
|
||||
# Sets up: data/, docs/, figures/, tables/, src/
|
||||
# Also initializes git repository and .gitignore
|
||||
initProject = {
|
||||
enable = true;
|
||||
path = {
|
||||
|
|
@ -18,6 +41,9 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# initDevenv: Initialize devenv project
|
||||
# Devenv provides additional development environment features
|
||||
# Only available if config.enabledPackages.devenv = true
|
||||
initDevenv = {
|
||||
enable = config.enabledPackages.devenv;
|
||||
path = {
|
||||
|
|
@ -26,6 +52,9 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# activateDevenv: Activate devenv shell
|
||||
# Automatically runs when entering dev shell if devenv.nix exists
|
||||
# Only available if config.enabledPackages.devenv = true
|
||||
activateDevenv = {
|
||||
enable = config.enabledPackages.devenv;
|
||||
path = {
|
||||
|
|
@ -33,6 +62,9 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# devenv: Run devenv commands
|
||||
# Access to full devenv CLI for managing development environments
|
||||
# Only available if config.enabledPackages.devenv = true
|
||||
devenv = {
|
||||
enable = config.enabledPackages.devenv;
|
||||
path = {
|
||||
|
|
@ -40,6 +72,9 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# updateDeps: Update all project dependencies
|
||||
# Updates: R packages (rixpkgs), Python (uv), Julia (Pkg), flake inputs
|
||||
# Automatically detects which languages are in use
|
||||
updateDeps = {
|
||||
enable = true;
|
||||
path = {
|
||||
|
|
@ -47,7 +82,9 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
node.enable = true;
|
||||
perl.enable = true;
|
||||
ruby.enable = true;
|
||||
# Additional language runtimes with minimal configuration
|
||||
# These are available but not heavily used by this template
|
||||
node.enable = true; # Node.js runtime (used by some LSPs)
|
||||
perl.enable = true; # Perl runtime
|
||||
ruby.enable = true; # Ruby runtime
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue