Merge pull request #61 from chfanghr/connor/templates

Add templates for quickly creating new projects

Author: szg251

.gitignore

@@ -26,4 +26,5 @@ cabal.sandbox.config
 .stack-work/
 .HTF/
 .ghc.environment.*
-.direnv/
+.direnv/
+dist-newstyle/

flake-lang/flake-haskell.nix

@@ -6,7 +6,7 @@ let
     , name
     , dependencies ? [ ]
     , devShellTools ? [ ]
-    , devShellHook
+    , devShellHook ? ""
     , devShellAdditionalPackages ? _: [ ]
     , index-state
     , compiler-nix-name

flake.nix

@@ -54,7 +54,7 @@
 
   outputs = inputs@{ flake-parts, ... }:
     flake-parts.lib.mkFlake { inherit inputs; } ({ flake-parts-lib, withSystem, ... }: {
-      systems = [ "x86_64-linux" "x86_64-darwin" ];
+      systems = [ "x86_64-linux" "x86_64-darwin" "aarch64-linux" "aarch64-darwin" ];
 
       imports = [
         # Project configuration
@@ -73,6 +73,8 @@
         ./examples/build.nix
         # Documentation
         ./docs/build.nix
+        # Templates
+        ./templates/build.nix
       ];
     });
 }

templates/build.nix

@@ -0,0 +1,22 @@
+{
+  flake = {
+    templates = {
+      haskell = {
+        path = ./haskell;
+        description = "A simple GHC/Cabal project using flake-lang.nix";
+      };
+      rust = {
+        path = ./rust;
+        description = "A simple Rust/Cargo project using flake-lang.nix";
+      };
+      rust-monorepo = {
+        path = ./rust-monorepo;
+        description = "A project consists of multiple rust crates using flake-lang.nix";
+      };
+      typescript = {
+        path = ./typescript;
+        description = "A Typescript/NPM project using flake-lang.nix";
+      };
+    };
+  };
+}

templates/haskell/.gitignore

@@ -0,0 +1,26 @@
+dist
+dist-*
+cabal-dev
+*.o
+*.hi
+*.hie
+*.chi
+*.chs.h
+*.dyn_o
+*.dyn_hi
+.hpc
+.hsenv
+.cabal-sandbox/
+cabal.sandbox.config
+*.prof
+*.aux
+*.hp
+*.eventlog
+.stack-work/
+.HTF/
+.ghc.environment.*
+.direnv/
+dist-newstyle/
+
+result
+result-*

templates/haskell/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for example
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

templates/haskell/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2024 YOUR NAME
+
+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, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+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.

templates/haskell/app/Main.hs

@@ -0,0 +1,8 @@
+module Main where
+
+import qualified MyLib (someFunc)
+
+main :: IO ()
+main = do
+    putStrLn "Hello, Haskell!"
+    MyLib.someFunc

templates/haskell/build.nix

@@ -0,0 +1,16 @@
+{ inputs, ... }: {
+  perSystem = { system, config, ... }:
+    let
+      hsFlake = inputs.flake-lang.lib.${system}.haskellFlake {
+        src = ./.;
+        name = "example";
+        inherit (config.settings.haskell) index-state compiler-nix-name;
+      };
+    in
+    {
+      inherit (hsFlake) packages checks;
+
+      // TODO(chfanghr): Unify the names of dev shells of different lanuages
+      devShells.dev-example-haskell = hsFlake.devShell;
+    };
+}

templates/haskell/example.cabal

@@ -0,0 +1,128 @@
+cabal-version:   3.0
+
+-- The cabal-version field refers to the version of the .cabal specification,
+-- and can be different from the cabal-install (the tool) version and the
+-- Cabal (the library) version you are using. As such, the Cabal (the library)
+-- version used must be equal or greater than the version stated in this field.
+-- Starting from the specification version 2.2, the cabal-version field must be
+-- the first thing in the cabal file.
+
+-- Initial package description 'example' generated by
+-- 'cabal init'. For further documentation, see:
+--   http://haskell.org/cabal/users-guide/
+--
+-- The name of the package.
+name:            example
+
+-- The package version.
+-- See the Haskell package versioning policy (PVP) for standards
+-- guiding when and how versions should be incremented.
+-- https://pvp.haskell.org
+-- PVP summary:     +-+------- breaking API changes
+--                  | | +----- non-breaking API additions
+--                  | | | +--- code changes with no API change
+version:         0.1.0.0
+
+-- A short (one-line) description of the package.
+-- synopsis:
+
+-- A longer description of the package.
+-- description:
+
+-- The license under which the package is released.
+license:         MIT
+
+-- The file containing the license text.
+license-file:    LICENSE
+
+-- The package author(s).
+author:          YOUR NAME
+
+-- An email address to which users can send suggestions, bug reports, and patches.
+maintainer:      [email protected]
+
+-- A copyright notice.
+-- copyright:
+build-type:      Simple
+
+-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.
+extra-doc-files: CHANGELOG.md
+
+-- Extra source files to be distributed with the package, such as examples, or a tutorial module.
+-- extra-source-files:
+
+common warnings
+  ghc-options: -Wall
+
+library
+  -- Import common warning flags.
+  import:           warnings
+
+  -- Modules exported by the library.
+  exposed-modules:  MyLib
+
+  -- Modules included in this library but not exported.
+  -- other-modules:
+
+  -- LANGUAGE extensions used by modules in this package.
+  -- other-extensions:
+
+  -- Other library packages from which modules are imported.
+  build-depends:    base ^>=4.18.2.1
+
+  -- Directories containing source files.
+  hs-source-dirs:   src
+
+  -- Base language which the package is written in.
+  default-language: Haskell2010
+
+executable example
+  -- Import common warning flags.
+  import:           warnings
+
+  -- .hs or .lhs file containing the Main module.
+  main-is:          Main.hs
+
+  -- Modules included in this executable, other than Main.
+  -- other-modules:
+
+  -- LANGUAGE extensions used by modules in this package.
+  -- other-extensions:
+
+  -- Other library packages from which modules are imported.
+  build-depends:
+    , base     ^>=4.18.2.1
+    , example
+
+  -- Directories containing source files.
+  hs-source-dirs:   app
+
+  -- Base language which the package is written in.
+  default-language: Haskell2010
+
+test-suite example-test
+  -- Import common warning flags.
+  import:           warnings
+
+  -- Base language which the package is written in.
+  default-language: Haskell2010
+
+  -- Modules included in this executable, other than Main.
+  -- other-modules:
+
+  -- LANGUAGE extensions used by modules in this package.
+  -- other-extensions:
+
+  -- The interface type and version of the test suite.
+  type:             exitcode-stdio-1.0
+
+  -- Directories containing source files.
+  hs-source-dirs:   test
+
+  -- The entrypoint to the test suite.
+  main-is:          Main.hs
+
+  -- Test dependencies.
+  build-depends:
+    , base     ^>=4.18.2.1
+    , example