nixos-contrib/mfgames-project-setup-flake
1
0
Fork 0
Code Issues 1 Pull requests Activity

Compare commits

base: nixos-contrib:ebd6b9196a3a40786913ad253223f190156975c8
Branches Tags
nixos-contrib:main
nixos-contrib:v0.1.0
..
compare: nixos-contrib:004975b3add96b77bca929c51d1c071eef632ca0
Branches Tags
nixos-contrib:main
nixos-contrib:v0.1.0

No commits in common. "ebd6b9196a3a40786913ad253223f190156975c8" and "004975b3add96b77bca929c51d1c071eef632ca0" have entirely different histories.
ebd6b9196a ... 004975b3ad

8 changed files with 8 additions and 488 deletions
Show stats Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,7 +1,6 @@
.direnv/
# nixago: ignore-linked-files
/DCO.md
/rustfmt.toml
/treefmt.toml
/.prettierrc.json

132
CODE_OF_CONDUCT.md
View file

@ -1,132 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
contact@mfgames.com. All complaints will be reviewed and investigated promptly
and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

115
README.md
View file

@ -1,115 +0,0 @@
# MfGames Project Setup Flake
_An opinionated setup for projects using Nix flakes._
According to Larry Wall, there are
[three virtues of a great coder](https://thethreevirtues.com/): laziness,
impatience, and hubris.
Over the years, the complexity of being a developer has only increased.
Fortunately (or unfortunately depending the mood), we have embraced laziness and
developed tools to help automate some of the more tedious tasks to ensure
everything is formatted correctly and properly recorded. This has resulted in
libraries such as:
- [EditorConfig](https://editorconfig.org/)
- [Conform](https://github.com/siderolabs/conform)
- [Lefthook](https://github.com/evilmartians/lefthook)
- [Prettier](https://prettier.io/)
- [Rustfmt](https://rust-lang.github.io/rustfmt/)
- [Treefmt](https://numtide.github.io/treefmt/)
In addition, we need to document policies that guide our projects:
- [Contributor Convenant](https://www.contributor-covenant.org/)
- [Developer Certificate of Origin](https://developercertificate.org/)
But, like the rest of the development world, all of these tools change and
evolve. New tools become useful to ensure formatting while others are taken over
by successors. Not to mention opinions and aesthetics change and what works
yesterday doesn't always look right today.
## Nix
This project is intended to be used with [Nix](https://nixos.wiki/wiki/Flakes)
flakes and can be used directly as an input.
```nix
{
inputs.mfgames-project-setup.url = "git+https://src.mfgames.com/nixos-contrib/mfgames-project-setup-flake.git";
}
```
This flake provides a function in `mfgames-project-setup.lib.mkConfig` that
creates a shell hook and the various tools required to run those hooks (because
programs like `lefthook` assume that the program is in the `PATH`).
```nix
config = mfgames-project-setup.lib.mkConfig {
inherit system pkgs;
# Options go here.
};
```
Of course, this being Nix, there are many ways of creating a devShell. This is
one way of using the config inside the shell.
```nix
devShells = forEachSupportedSystem ({ system, pkgs }:
let
config = inputs.mfgames-project-setup.lib.mkConfig {
inherit system pkgs;
conform.scopes = [ "cli" "website" ];
rust.enable = false;
};
in
{
default = pkgs.mkShell {
# Add in the required packages for the configuration.
packages = [] ++ config.packages;
# Add in the
shellHook = ''
${config.shellHook}
'';
};
});
```
## Options
This is definately opinionated, mainly by the virtue that is primarily used by a
single developer. Internally, this uses
[Nixago](https://github.com/nix-community/nixago) (including a little hacking
for text files).
### conform.scopes
Controls which scope is allowed inside the
[Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/).
Defaults to `[]`. An example would be `["cli" "infra"]`.
### contributorCovenant.enable
If set to true, then a `CODE_OF_CONDUCT.md` will be created using information
from `contributorCovenant.contact` for the contact information. If the contact
is missing, this will assert.
Defaults to `false`.
### contributorCovenant.contact
Set this to the value for the contact information inside the
`CODE_OF_CONDUCT.md` file. This can be an email or a website.
### developerCertificateOfOrigin.enable
If set to true, then a `DCO.md` will be created using the boilerplate text from
https://developercertificate.org/.
Defaults to `false`.
### rust.enable
If set to true, then `rustfmt.toml` will be created.

25
flake.nix
View file

@ -28,39 +28,26 @@
{ system
, pkgs
, conform ? { }
, contributorCovenant ? { }
, developerCertificateOfOrigin ? { }
, rust ? { }
, ...
}:
let
conformDefaults = { scopes = [ ]; };
contributorCovenantDefaults = { enable = false; };
developerCertificateOfOriginDefaults = { enable = false; };
rustDefaults = { enable = false; };
text-engine = import ./src/engines/text.nix {
inherit pkgs;
lib = pkgs.lib;
};
conformDefaults = { scopes = [ ]; };
configs = import ./src/configs/default.nix {
inherit system pkgs nixago nixago-exts;
text-engine = text-engine { };
contributorCovenant = contributorCovenantDefaults // contributorCovenant;
developerCertificateOfOrigin = developerCertificateOfOriginDefaults // developerCertificateOfOrigin;
conform = conformDefaults // conform;
rust = rustDefaults // rust;
};
in
{
packages = [ pkgs.lefthook pkgs.treefmt ];
packages = [ pkgs.lefthook ];
shellHook = ''
${configs.shellHook}
${pkgs.lefthook}/bin/lefthook install
alias lefthook="${pkgs.lefthook}/bin/lefthook"
'';
};
};
@ -70,9 +57,7 @@
let
config = lib.mkConfig {
inherit system pkgs;
contributorCovenant.enable = true;
contributorCovenant.contact = "contact@mfgames.com";
developerCertificateOfOrigin.enable = true;
#rust.enable = false;
};
in
{

144
src/configs/contributorCovenant.nix
View file

@ -1,144 +0,0 @@
# https://www.contributor-covenant.org/
inputs @ { pkgs, text-engine, contributorCovenant, ... }:
assert pkgs.lib.assertMsg
(contributorCovenant ? "contact") "contributorCovenant.contact must be set";
{
output = "CODE_OF_CONDUCT.md";
engine = text-engine;
hook.mode = "copy";
data = ''
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
${contributorCovenant.contact}.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
'';
}

17
src/configs/default.nix
View file

@ -1,23 +1,12 @@
inputs @ { pkgs
, contributorCovenant
, developerCertificateOfOrigin
, rust
, ...
}:
let lib = pkgs.lib;
in inputs.nixago.lib.${inputs.system}.makeAll ([
inputs @ { pkgs, rust ? { enable = false; }, ... }:
let lib = pkgs.lib; in
inputs.nixago.lib.${inputs.system}.makeAll ([
(import ./conform.nix (inputs))
(import ./editorconfig.nix (inputs))
(import ./lefthook.nix (inputs))
(import ./prettier.nix (inputs))
(import ./treefmt.nix (inputs))
]
++ lib.optionals contributorCovenant.enable [
(import ./contributorCovenant.nix (inputs))
]
++ lib.optionals developerCertificateOfOrigin.enable [
(import ./developerCertificateOfOrigin.nix (inputs))
]
++ lib.optionals rust.enable [
(import ./rustfmt.nix (inputs))
])

44
src/configs/developerCertificateOfOrigin.nix
View file

@ -1,44 +0,0 @@
# https://developercertificate.org/
inputs @ { pkgs, text-engine, ... }:
{
output = "DCO.md";
engine = text-engine;
hook.mode = "copy";
data = ''
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
'';
}

18
src/engines/text.nix
View file

@ -1,18 +0,0 @@
/*
The nix engine uses pkgs.formats for generating output data.
The engine takes a single parameter (`opts`) which is subsequently passed to
the specified generator when instantiating it. See the pkgs.formats entries
for which options are available for each generator type.
The `type` field of the request determines which generator is invoked. The
type must be a name in the set produced by `pkgs.formats`.
*/
{ pkgs, ... }:
opts: request:
let
inherit (request) data format output;
name = "text";
value = data;
in
pkgs.writeText name value