nix-common-lisp

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #llm #android #machine-learning #rust #linux #macos #nodejs #cli #ios

nix-common-lisp

(★ 10)

Nix template for Common Lisp projects (SBCL, CCL, ECL, ABCL, CLISP, Clasp, MKCL, CMUCL)

nix-common-lisp 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Nix templates for Common Lisp projects

This repository contains a Nix template for Common Lisp projects.

## Usage

### Run entrypoint

The entrypoint of this project is `main` function.
You can run it with the following command:

```sh
nix run .#main-sbcl
```

- `.#main-sbcl`: Run the entrypoint using SBCL.
- `.#main-ecl`: Run the entrypoint using ECL.
- `.#main-abcl`: Run the entrypoint using ABCL.
- `.#main-ccl`: Run the entrypoint using CCL.
- `.#main-mkcl`: Run the entrypoint using MKCL.
- `.#main-clisp`: Run the entrypoint using CLISP.
- `.#main-cmucl_binary`: Run the entrypoint using CMUCL.
- `.#main-clasp-common-lisp`: Run the entrypoint using Clasp.

### Run tests

The tests of this project are located in the `test` directory.
You can run them with the following command:

```sh
nix run .#test-sbcl
```

We use [FiveAM](https://github.com/lispci/fiveam) for testing.

- `.#test-sbcl`: Run all tests using SBCL.
- `.#test-ecl`: Run all tests using ECL.
- `.#test-abcl`: Run all tests using ABCL.
- `.#test-ccl`: Run all tests using CCL.
- `.#test-mkcl`: Run all tests using MKCL.
- `.#test-clisp`: Run all tests using CLISP.
- `.#test-cmucl_binary`: Run all tests using CMUCL.
- `.#main-clasp-common-lisp`: Run all tests using Clasp.

#### Code coverage

You can also run the test with code coverage using the following command:

- `.#coverage-sbcl`: Run all tests with code coverage using SBCL.

### Run REPL

You can run a REPL with the following command:

```sh
nix develop -c sbcl # ecl, abcl, or ccl, mkcl, lisp, clisp, clasp
```

To load the project, you can use the following code:

```lisp
(require :uiop)
(load (uiop:getenv "ASDF"))
(require :fibonacci)
```

### Packages

This project exports the following packages:

- `packages.lib-sbcl`: library for SBCL.
- `packages.lib-ecl`: library for ECL.
- `packages.lib-abcl`: library for ABCL.
- `packages.lib-ccl`: library for CCL.
- `packages.lib-mkcl`: library for MKCL.
- `packages.lib-clisp`: library for CLISP.
- `packages.lib-cmucl_binary`: library for CMUCL.
- `packages.lib-clasp-common-lisp`: library for Clasp.

- `packages.main-sbcl`: executable for SBCL.
- `packages.main-ecl`: executable for ECL.
- `packages.main-abcl`: executable for ABCL.
- `packages.main-ccl`: executable for CCL.
- `packages.main-mkcl`: executable for MKCL.
- `packages.main-clisp`: executable for CLISP.
- `packages.main-cmucl_binary`: executable for CMUCL.
- `packages.main-clasp-common-lisp`: executable for Clasp.

### Overlays

This project exports the overlay.

- `overlays.default`: it adds following packages:
  - `pkgs.fibonacci-sbcl`: it is equivalent to `packages.main-sbcl`.
  - `pkgs.fibonacci-ecl`: it is equivalent to `packages.main-ecl`.
  - `pkgs.fibonacci-abcl`: it is equivalent to `packages.main-abcl`.
  - `pkgs.fibonacci-ccl`: it is equivalent to `packages.main-ccl`.
  - `pkgs.fibonacci-mkcl`: it is equivalent to `packages.main-mkcl`.
  - `pkgs.fibonacci-clisp`: it is equivalent to `packages.main-clisp`.
  - `pkgs.fibonacci-cmucl_binary`: it is equivalent to `packages.main-cmucl_binary`.
  - `pkgs.fibonacci-clasp-common-lisp`: it is equivalent to `packages.main-clasp-common-lisp`.

- `pkgs.sbcl.fibonacci`: it is equivalent to `packages.lib-sbcl`.
  - `pkgs.ecl.fibonacci`: it is equivalent to `packages.lib-ecl`.
  - `pkgs.abcl.fibonacci`: it is equivalent to `packages.lib-abcl`.
  - `pkgs.ccl.fibonacci`: it is equivalent to `packages.lib-ccl`.
  - `pkgs.mkcl.fibonacci`: it is equivalent to `packages.lib-mkcl`.
  - `pkgs.clisp.fibonacci`: it is equivalent to `packages.lib-clisp`.
  - `pkgs.cmucl_binary.fibonacci`: it is equivalent to `packages.lib-cmucl_binary`.
  - `pkgs.clasp-common-lisp.fibonacci`: it is equivalent to `packages.lib-clasp-common-lisp`.

To use the overlay,

- nix flakes without any frameworks
  ```nix
  let
      pkgs = import nixpkgs {
        inherit system;
        overlays = [
          fibonacci.overlays.default
        ];
      };
  ```
- [flake-parts](https://flake.parts/overlays.html?highlight=overlays#consuming-an-overlay)
  ```nix
  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
    flake-parts.url = "github:hercules-ci/flake-parts";
    papyrus = {
      url = "github:tani/papyrus";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };
  ```
  ```nix
    perSystem = { system, ... }: {
      _module.args.pkgs = import inputs.nixpkgs {
        inherit system;
        overlays = [
          inputs.papyrus.overlays.default
        ];
        config = { };
      };
    };
  ```

## Development

First, you need to rename the project name.
We attached the rename script for this purpose.

```sh
vim ./rename.sh # Edit the project name
./rename.sh
```

Then, you might update the dependency (`lispLibs`).

Now you can start developing your project.
Note that this project uses _package-inferred-system_.

## License

This project is inspired by
[Comamoca/nix-template](https://github.com/Comamoca/scaffold/tree/main/cl-nix),
which is licensed under the CC0 1.0 Universal license.

This projects is licensed under the following license:

>
> MIT No Attribution
>
> Copyright 2024 Masaya Taniguchi
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this
> software and associated documentation files (the "Software"), to deal in the Software
> without restriction, including without limitation the rights to use, copy, modify,
> merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
> permit persons to whom the Software is furnished to do so.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
> INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
> PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
> HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

nix-common-lisp

nix-common-lisp 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

nix-common-lisp

nix-common-lisp 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README