Code Monkey home page Code Monkey logo

frost's Introduction

Snowfall Frost

Nix Flakes Ready Built With Snowfall

  

Generate documentation for Nix Flakes.

Installation

Nix Profile

You can install this package imperatively with the following command.

nix profile install github:snowfallorg/frost

Nix Configuration

You can install this package by adding it as an input to your Nix Flake.

{
	description = "My system flake";

	inputs = {
		nixpkgs.url = "github:nixos/nixpkgs/nixos-23.05";
		unstable.url = "github:nixos/nixpkgs/nixos-unstable";

		# Snowfall Lib is not required, but will make configuration easier for you.
		snowfall-lib = {
			url = "github:snowfallorg/lib";
			inputs.nixpkgs.follows = "nixpkgs";
		};

		snowfall-frost = {
			url = "github:snowfallorg/frost";
			inputs.nixpkgs.follows = "nixpkgs";
		};
	};

	outputs = inputs:
		inputs.snowfall-lib.mkFlake {
			inherit inputs;
			src = ./.;

			overlays = with inputs; [
				# Use the default overlay provided by this flake.
				snowfall-frost.overlays.default

				# There is also a named overlay, though the output is the same.
				snowfall-frost.overlays."package/frost"
			];
		};
}

If you've added the overlay from this flake, then in your system configuration you can add the snowfallorg.frost package.

{ pkgs }:

{
	environment.systemPackages = with pkgs; [
		snowfallorg.frost
	];
}

Usage

frost build

Build documentation for a given flake.

frost build github:snowfallorg/cowsay

frost's People

Contributors

jakehamilton avatar

Stargazers

PopeRigby avatar Tomo avatar Rusty avatar Marcus Montgomery avatar Kayla Firestack avatar Martin Myrseth avatar Paul Haerle avatar Daniel Kahlenberg avatar Shinedog avatar dzmitry-lahoda avatar  avatar vi|vi|vi avatar カシオ 金城 大関 avatar pyranota avatar  avatar  avatar Eric Bailey avatar  avatar Russ  avatar Adam Gaia avatar  avatar

Watchers

 avatar Oto Petřík avatar pinage404 avatar  avatar

Forkers

fvkd

frost's Issues

Can't get frost to work

This project looks really cool and I'd love to use it, but it doesn't seem to work for me at all.

It hangs for a while then I either get generic, empty output, or errors like the following. Any advice?

image

λ nix profile install github:snowfallorg/frost
λ frost build github:yurrriq/dotfiles
 INFO   Frost Build
 FATAL  Frost Command failed: nix build '/nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv^*' --out-link /home/eric/src/gitlab.sportradar.ag/nix/asimov/frost-docs
this derivation will be built:
  /nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv
building '/nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv'...
error: builder for '/nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv' failed with exit code 1;
       last 10 log lines:
       >
       >
       > ERROR: `npm build` failed
       >
       > Here are a few things you can try, depending on the error:
       > 1. Make sure your build script (build) exists
       >   If there is none, set `dontNpmBuild = true`.
       > 2. If the error being thrown is something similar to "error:0308010C:digital envelope routines::unsupported", add `NODE_OPTIONS = "--openssl-legacy-provider"` to your derivation
       >   See https://github.com/webpack/webpack/issues/14532 for more information.
       >
       For full logs, run 'nix log /nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv'.

 FATAL  Frost this derivation will be built:
 FATAL  Frost   /nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv
 FATAL  Frost building '/nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv'...
 FATAL  Frost error: builder for '/nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv' failed with exit code 1;
 FATAL  Frost        last 10 log lines:
 FATAL  Frost        >
 FATAL  Frost        >
 FATAL  Frost        > ERROR: `npm build` failed
 FATAL  Frost        >
 FATAL  Frost        > Here are a few things you can try, depending on the error:
 FATAL  Frost        > 1. Make sure your build script (build) exists
 FATAL  Frost        >   If there is none, set `dontNpmBuild = true`.
 FATAL  Frost        > 2. If the error being thrown is something similar to "error:0308010C:digital envelope routines::unsupported", add `NODE_OPTIONS = "--openssl-legacy-provider"` to your derivation
 FATAL  Frost        >   See https://github.com/webpack/webpack/issues/14532 for more information.
 FATAL  Frost        >
 FATAL  Frost        For full logs, run 'nix log /nix/store/79jslk9xcmb7ckq8sy3xzadkdnjw5iib-frost-ui-0.0.1.drv'.
 FATAL  Frost 
 FATAL  Frost     at ChildProcess.exithandler (node:child_process:419:12)
 FATAL  Frost     at ChildProcess.emit (node:events:514:28)
 FATAL  Frost     at maybeClose (node:internal/child_process:1091:16)
 FATAL  Frost     at ChildProcess._handle.onexit (node:internal/child_process:302:5)

Fatal errors

Hey, came across this while trying to update my README and saw your documentation site mentioning this project. But, trying to run it I just get

frost build github:khaneliman/khanelinix
   INFO   Frost Build
 ﮊ  FATAL  Frost Cannot read properties of undefined (reading 'kind')
 ﮊ  FATAL  Frost     at w.parseComments (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:9988)
 ﮊ  FATAL  Frost     at w.parseSubExpr (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:6517)
 ﮊ  FATAL  Frost     at w.parseExpr (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:3076)
 ﮊ  FATAL  Frost     at w.parseKeyword (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:13911)
 ﮊ  FATAL  Frost     at w.parseSubExpr (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:5732)
 ﮊ  FATAL  Frost     at w.parseExpr (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:3076)
 ﮊ  FATAL  Frost     at w.parseTokens (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:2985)
 ﮊ  FATAL  Frost     at w.parseInterp (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:7463)
 ﮊ  FATAL  Frost     at w.parseSubExpr (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:5273)
 ﮊ  FATAL  Frost     at w.parseExpr (/nix/store/9pc8z2h0zgh8vfclm5jz9lxpj3rx5qm3-frost/lib/node_modules/frost/node_modules/@snowfallorg/sleet/dist/sleet.cjs.js:10:3076)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.