Compare commits

...

No commits in common. "master" and "confusion" have entirely different histories.

365 changed files with 1132 additions and 18817 deletions

49
.github/CODEOWNERS vendored
View File

@ -1,49 +0,0 @@
# Reference to configuration - https://github.blog/2017-07-06-introducing-code-owners/
# Relevant https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
# This file is used to set permission per team or user to allow auto-merging
# Maintainers
* @kreyren @RXT0112/maintainers
# Documentation maintainers
/docs/ @RXT0112/documentators
# Dependencies
Cargo.toml @dependabot-preview
requirements.txt @dependabot-preview
# Legal team
LICENSE.md @kreyren
# Rustlang maintainers
*.rs @RXT0112/rustlang
Cargo.toml @RXT0112/rustlang
# Python maintainers
*.py @RXT0112/python
requirements.txt @RXT0112/python
# Vlang maintainers
*.v @RXT0112/vlang
# Clang maintainers
*.c @RXT0112/clang
# CPP maintainers
*.cpp @RXT0112/cpp
# Shell maintainers
*.sh @RXT0112/shell
# Bash maintainers
*.bash @RXT0112/bash
# Brainfuck maintainers
*.br @RXT0112/brainfuck
# java maintainers
*.jar @RXT0112/java
# csharp maintainers
*.cs @RXT0112/csharp

View File

@ -1,9 +0,0 @@
# Contributing guideliness
FIXME: Preamble needed
FIXME: Do not assign translate variables in fixme messages
### Translate the project
Search the code for `FIXME-TRANSLATE` and add logic for your language

3
.github/FUNDING.yml vendored
View File

@ -16,5 +16,4 @@ issuehunt: rixotstudio
otechie: rixotstudio
# Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
# Referer link on github.com/kreyren
custom: https://my.fsf.org/join?referrer=3706032
custom: https://my.fsf.org/join

View File

@ -1,33 +0,0 @@
---
name: Bug report
about: if Something is not working as expected
title: 'bug:'
labels: 'bug'
assignees: '@Zernit/bugwranglers'
---
### Describe the bug
<!-- Give us a **short** summary of what the issue is -->
text
### To Reproduce
<!-- Provide steps to reproduce otherwise the issue will be considered as invalid -->
1. ...
2. ...
### Expected behavior
<!-- What do you expect to happend instead of current behavior? -->
text
### Additional context
<!-- Add any other context about the issue here -->
text
### What do you expect to happend to solve this issue?
<!-- To specify expected behavior from an upstream -->
text

View File

@ -1,10 +0,0 @@
# Disable blank issues
blank_issues_enabled: false
contact_links:
- name: IRC
url: https://webchat.freenode.net/#zernit
about: For simple questions and brainstorming
- name: Discord
url: https://discord.gg/5V4psY
about: Community maintained support in Zernit section

View File

@ -1,20 +0,0 @@
---
name: Feature request
about: For feature proposals
title: 'REQUEST:'
labels: 'feature-request'
assignees: '@Zernit/bugwranglers'
---
### Describe the feature
<!-- Give us a **short** summary of your proposed feature -->
### Expected behavior
<!-- What do you expect to happend instead of current behavior? -->
### Additional context
<!-- Add any other context about the issue here -->

View File

@ -1,8 +0,0 @@
---
name: Legal request
about: To propose changes in the license
labels: 'license'
assignees: '@Zernit/legal-team'
---
<!-- Please keep your request as short as possible, the longer the request the longer it's going to take for us to process it -->

View File

@ -1,9 +0,0 @@
---
name: Other
about: If none of the above fits your request
labels: 'assign-me'
assignees: '@Zernit/helpers'
---
<!-- Please keep your request as short as possible, the longer the request the longer it's going to take for us to process it -->

View File

@ -1,10 +0,0 @@
---
name: Question
about: In case you need upstream help
title: 'Q:'
labels: 'question'
assignees: '@Zernit/helpers'
---
<!-- Please keep your question as short as possible, the longer the question the longer it's going to take for us to process it -->

87
.github/README.md vendored
View File

@ -1,86 +1,15 @@
**FIXME:** Markdownlint has to be optimized for this file<br>
**FIXME:** Source the header in different markdown file to make GitHub README different from GitLab.
fixme: Source the header in different markdown file to make GitHub README different from GitLab
**FIXME:** Change the name based on name repository used.
fixme: Change the name based on repository used
<h1 align="center">
<a href=https://github.com/RXT0112/Zernit>Zernit</a> (RXT0112)
</h1>
<h4 align="center">Community maintained (FIXME: Unknown clarification) designed to work cross-platform and using multiple programming languages depending on which one provides the most efficiency per required runtime on target system</h4>
# RXT0112 (WIP name)
<p align="center">
<img src="https://img.shields.io/badge/Maintained%3F-Yes-green?style=for-the-badge">
<img src="https://img.shields.io/github/license/RXT0112/Zernit?style=for-the-badge">
<img src="https://img.shields.io/github/issues/RXT0112/Zernit?color=violet&style=for-the-badge">
<img src="https://img.shields.io/github/stars/RXT0112/Zernit?style=for-the-badge">
<img src="https://img.shields.io/github/forks/RXT0112/Zernit?color=teal&style=for-the-badge">
</p>
Package manager for unix and windows written in rustlang
**NOTICE:** Code-related implementation merge requests are currently not accepted due to the lack of repository management for multi-language project which is currently being worked on, however merge request will be processed if submitted with a priority affected by this restriction.
**FIXME:** Change the URL based on the website used<br>
fixme: Change the URL based on the website used<br>
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/RXT0112/RXT0112)
**FIXME:** Add a pretty button<br>
**FIXME:** codesandbox currently cannot be used for zernit<br>
**FIXME:** Add tracking for scodsandbox usage on zernit<br>
https://codesandbox.io/sgithub/RXT0112/RXT0112
## ABSTRACT
Package manager capable of source and binary export with tracking in `world` file and options.
**FIXME:** Change the URL based on the website used<br>
**FIXME:** repl.it currently cannot be used for zernit<br>
**FIXME:** Add tracking for scodsandbox usage on zernit<br>
[![Run on Repl.it](https://repl.it/badge/github/RXT0112/Zernit)](https://repl.it/github/RXT0112/Zernit)
## When to make a new issue?
### Questions
All relavant questions are welcomed and will be answered as soon as possible depending on the lenght of the question and the understanding of the supporter.
### Bugs
Everything relevant that does not work as expected or can be improved. The more issues we are aware of the more work we can put in to resolve them.
### Feature requests
Propose anything we will listen and consider it as long as it's relevant.
### Legal requests
**NOTICE:** This is currently being implemented so there might be a delay in responses due to the lack of resources
This project has custom community maintained license which is designed to avoid common issues related to FSF/GNU/OSS-endorsed licenses while directing the workflow, see License below for more info.
Anything relevant to legal is welcomed in:
- Our bug tracker
- Mentioning `@RXT0112/legal-team` in your relevant GitHub tickets
- Sending an e-mail on [zernit-legal@rixotstudio.cz](mailto:zernit-legal@rixotstudio.cz)
## Mentoring program
**NOTICE:** This is currently work in progress and provided with limited resources
This project provides a free mentoring program for anyone who makes a new merge request with (TBD)
This mentoring support is provided by the community for the community to provide a free education to improve the community-wide code quality and to ensure that everyone who wants to code has the resources to start and learn.
If you need a help on projects outside of project RXT0112 then mension `@RXT0112/mentors` in your GitHub tickets.
Mentoring support is also provided on community server (TBD)
Project RXT0112 hopes to provide an environment for everyone to learn, freel free to mension our mentoring program in your repositories.
## Where to get support
1. For simple questions, guidance and mentoring use chat on https://webchat.freenode.net/#zernit-support
2. For complicated issues either:
- Mension `@RXT0112/support` in your issues or relevant merge requests on GitHub
- Make a new issue in relevant RXT0112 organization (anything relevant is welcomed!)
3. Sent an email on [zernit-support@rixotstudio.cz](mailto:zernit-support@rixotstudio.cz)
## License
This project is designed around a community maintained license that is used to direct a workflow while preserving end-user's freedoms to fix common FSF/GNU/OSS-endorsed license issues (FIXME: Reference the issues) that would allow blockchain implementation and for-profit business plan.
**NOTICE:** The for-profit business plan is currently being investigated to make it suitable for this project, might be turned in non-profit
Developed with GUI in mind

View File

@ -1,8 +0,0 @@
# Container image that runs your code
FROM alpine:3.10
# Copies your code file from your action repository to the filesystem path `/` of the container
COPY entrypoint.sh /entrypoint.sh
# Code file to execute when the docker container starts up (`entrypoint.sh`)
ENTRYPOINT ["/entrypoint.sh"]

View File

@ -1,21 +0,0 @@
MIT License
Copyright (c) 2019 GitHub Actions
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.

View File

@ -1,23 +0,0 @@
# Hello world docker action
This action prints "Hello World" to the log or "Hello" + the name of a person to greet. To learn how this action was built, see "[Creating a Docker container action](https://help.github.com/en/articles/creating-a-docker-container-action)" in the GitHub Help documentation.
## Inputs
### `who-to-greet`
**Required** The name of the person to greet. Default `"World"`.
## Outputs
### `time`
The time we greeted you.
## Example usage
```yaml
uses: actions/hello-world-docker-action@master
with:
who-to-greet: 'Mona the Octocat'
```

View File

@ -1,17 +0,0 @@
# FIXME: Hook https://man.sr.ht/builds.sr.ht/api.md so that we can use sourcehub in GitHub action
name: 'Hello World'
description: 'Greet someone and record the time'
inputs:
who-to-greet: # id of input
description: 'Who to greet'
required: true
default: 'World'
outputs:
time: # id of output
description: 'The time we greeted you'
runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.who-to-greet }}

View File

@ -1,5 +0,0 @@
#!/bin/sh -l
echo "Hello $1"
time=$(date)
echo ::set-output name=time::$time

49
.github/label-pr.yml vendored
View File

@ -1,49 +0,0 @@
# Programming language specific
- regExp: ".*\\.rs+$"
labels: ["rustlang"]
- regExp: ".*\\.py+$"
labels: ["python"]
- regExp: ".*\\.c+$"
labels: ["c-lang"]
- regExp: ".*\\.cpp+$"
labels: ["CPP"]
- regExp: ".*\\.sh+$"
labels: ["shell"]
- regExp: ".*\\.bash+$"
labels: ["bash"]
- regExp: ".*\\.br+$"
labels: ["brainfuck"]
- regExp: ".*\\.jar+$"
labels: ["java"]
- regExp: ".*\\.v+$"
labels: ["vlang"]
- regExp: ".*\\.cs+$"
labels: ["csharp"]
- regExp: "^/tests/.*"
labels: ["tests"]
- regExp: "^/benches/.*"
labels: ["benches"]
- regExp: "^/LICENSE/.*"
labels: ["license"]
- regExp: ".*\\.md+$"
labels: ["markdown"]
- regExp: "^(Cargo\\.toml|requirements\\.txt)$"
labels: ["dependencies"]
# Repository specific
- regExp: "^/docs/.*"
labels: ["docs"]

112
.github/labels.yml vendored
View File

@ -1,112 +0,0 @@
# This file handles labels on GitHub
# Priority handling
- name: P - SHTF
color: ae00ff
description: "Stop whatever you are doing and focus on this"
- name: P - Very High
color: ff2f00
description: "FIXME"
- name: P - High
color: 910f00
description: "FIXME"
- name: P - Med
color: ffd000
description: "FIXME"
- name: P - Low
color: b3ff00
description: "FIXME"
- name: P - Very Low
color: 73ff00
description: "FIXME"
# MISC
- name: bug
color: d73a4a
description: "Something isn't working"
- name: question
color: 7300ff
description: "For questions"
- name: feature-request
color: 03fc5a
description: "Feature requests"
- name: docs
color: 0075ca
description: "Improvements or additions to documentation"
- name: duplicate
color: cfd8d7
description: "This issue or pull request already exists"
- name: enhancement
color: a22eef
description: "Proposal for code improvement"
- name: license
color: 1a7546
description: "Relevant to licensing"
- name: dependencies
color: ca0ef0
description: "Relevant to dependencies"
- name: tests
color: 8d0fd6
description: "Relevant to tests"
- name: benches
color: cc1250
description: "Relevant to benchmarks"
# Programming language specific
- name: python
color: 00aeff
description: "Relevant to python"
- name: rustlang
color: f58142
description: "Relevant to rustlang"
- name: c-lang
color: 427bf5
description: "Relevant to c-lang"
- name: brainfuck
color: f542c5
description: "Relevant to brainfuck"
- name: shell
color: 74e63c
description: "Relevant to shell"
- name: bash
color: 9dff00
description: "Relevant to bash"
- name: CCP
color: 009dff
description: "Relevant to CCP"
- name: vlang
color: 03cafc
description: "Relevant to vlang"
- name: csharp
color: 08400a
description: "Relevant to csharp"
- name: java
color: ad690a
description: "Relevant to java"
- name: markdown
color: 454545
description: "Relevant to markdown"

View File

@ -1,9 +0,0 @@
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Hello world action step
uses: ./.github/custom-actions/sourcehub-layer

View File

@ -1,176 +0,0 @@
# Workflow for cpp
name: cpp
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.cpp'
jobs:
# Linting
lint-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Installing dependencies..
run: if ! apt list --installed | grep -qP ".*cppcheck.*"; then sudo apt install -y cppcheck; fi
- name: Linting..
run: cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.cpp$''); do cppcheck "$file"; done
# Kernel specific builds
build-macos-gcc-cpp:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-windows-gcc-cpp:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-macos-clang-cpp:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
build-windows-clang-cpp:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
# Docker builds
## Debian - testing
build-gcc-cpp-debian:
runs-on: ubuntu-latest
steps:
- uses: docker://debian/testing:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-clang-cpp-debian:
runs-on: ubuntu-latest
steps:
- uses: docker://debian/testing:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
## Fedora - latest
build-gcc-cpp-fedora:
runs-on: ubuntu-latest
steps:
- uses: docker://fedora/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-clang-cpp-fedora:
runs-on: ubuntu-latest
steps:
- uses: docker://fedora/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
## Archlinux - latest
build-gcc-cpp-archlinux:
runs-on: ubuntu-latest
steps:
- uses: docker://archlinux/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-clang-cpp-archlinux:
runs-on: ubuntu-latest
steps:
- uses: docker://archlinux/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
## Gentoo stage3-amd64
build-gcc-cpp-gentoo:
runs-on: ubuntu-latest
steps:
- uses: docker://gentoo/stage3-amd64:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-clang-cpp-gentoo:
runs-on: ubuntu-latest
steps:
- uses: docker://gentoo/stage3-amd64:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
## Exherbo
build-gcc-cpp-exherbo:
runs-on: ubuntu-latest
steps:
- uses: docker://exherbo/exherbo_ci:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-cpp
build-clang-cpp-exherbo:
runs-on: ubuntu-latest
steps:
- uses: docker://exherbo/exherbo_ci:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-cpp
# Run tests
## Exherbo (Linux representative)
check-exherbo-gcc-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- run: make check-gcc-cpp
check-exherbo-clang-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- run: make check-clang-cpp
## Windows
check-windows-gcc-cpp:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- run: make check-gcc-cpp
check-windows-clang-cpp:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- run: make check-clang-cpp
## Darwin
check-darwin-gcc-cpp:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: make check-gcc-cpp
check-darwin-clang-cpp:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: make check-clang-cpp
# Benchmarks
## Exherbo
bench-exherbo-gcc-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- name: running benchmarks..
run: make bench-gcc-cpp
bench-exherbo-clang-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- name: running benchmarks..
run: make bench-clang-cpp

View File

@ -1,22 +0,0 @@
# Workflow for CPP
name: Jekyll
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- 'docs/**'
jobs:
jekyll:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Get dependencies (FIXME-UPSTREAM)
run: sudo gem install jekyll
- name: Building..
# FIXME: Avoid using `cd`
run: cd docs && jekyll build

View File

@ -1,31 +0,0 @@
# Workflow for CPP
name: Jekyll Publish
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
push:
branches:
- master
- init-new
paths:
- 'docs/_posts/**'
jobs:
jekyll:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Get dependencies (FIXME-UPSTREAM)
run: sudo gem install jekyll
- name: Building..
# FIXME: Avoid using `cd`
run: cd docs && jekyll build
- name: Deploying..
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_REPOSITORY: ${{ secrets.GITHUB_REPOSITORY }}
GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}
uses: BryanSchuetz/jekyll-deploy-gh-pages@master

View File

@ -1,91 +0,0 @@
# Workflow for vlang
name: vlang
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.v'
jobs:
# Kernel specific builds
build-ubuntu-vlang:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
if ! command -v v >/dev/null; then
wget https://github.com/vlang/v/releases/latest/download/v_linux.zip -O "$HOME/.cache/vlang.zip"
[ ! -d /opt/vlang ] && mkdir /opt/vlang
[ ! -d "$HOME/.cache/" ] && mkdir "$HOME/.cache/"
[ ! -f /opt/vlang/v ] && unzip "$HOME/.cache/vlang.zip" -d /opt/vlang/v
[ ! -x /usr/bin/v ] && ln -sf /usr/bin/v /opt/vlang/v
fi
- name: Building..
run: make build-vlang
build-darwin-vlang:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
if ! command -v v >/dev/null; then
wget https://github.com/vlang/v/releases/latest/download/v_linux.zip -O "$HOME/.cache/vlang.zip"
[ ! -d /opt/vlang ] && mkdir /opt/vlang
[ ! -d "$HOME/.cache/" ] && mkdir "$HOME/.cache/"
[ ! -f /opt/vlang/v ] && unzip "$HOME/.cache/vlang.zip" -d /opt/vlang/v
[ ! -x /usr/bin/v ] && ln -sf /usr/bin/v /opt/vlang/v
fi
- name: Building..
run: make build-vlang
build-windows-vlang:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
ECHO fixme
EXIT
- name: Building..
run: make build-vlang
# Docker builds
build-vlang-debian:
runs-on: ubuntu-latest
steps:
- uses: docker://debian/testing:latest
- uses: actions/checkout@v2
- name: building..
run: make build-vlang
build-vlang-fedora:
runs-on: ubuntu-latest
steps:
- uses: docker://fedora/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-vlang
# Run tests
check-vlang:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macos-latest, windows-latest, ubuntu-18.04]
steps:
- uses: actions/checkout@v2
- name: running tests..
run: make check-vlang
# Benchmarks
bench-vlang:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macos-latest, windows-latest, ubuntu-18.04]
steps:
- uses: actions/checkout@v2
- name: running benchmarks..
run: make bench-vlang

View File

@ -1,67 +0,0 @@
name: Bash
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.bash'
- "tools/dockerfreeze"
jobs:
# Linting
lint:
runs-on: ubuntu-latest
container: debian:stable
steps:
- name: Installing dependencies..
run: |
# Sync repos
# Check for git
if ! apt list --installed 2>/dev/null | grep -qP "^git\/stable.*"; then
# Check if we can install git
if ! apt list | grep -qP "^git\/stable.*"; then
apt update
elif apt list | grep -qP "^git\/stable.*"; then
true
else
exit 255
fi
# Install git
apt install -y git
elif apt list --installed 2>/dev/null | grep -qP "^git\/stable.*"; then
true
else
exit 255
fi
# Check for shellcheck
if ! apt list --installed 2>/dev/null | grep -qP "^shellcheck\s{1}-.*"; then
# Check if we can install shellcheck
if ! apt list | grep -qP "^shellcheck\s{1}-.*"; then
apt update
elif apt list | grep -qP "^shellcheck\s{1}-.*"; then
true
else
exit 255
fi
# Install shellcheck
apt install -y shellcheck
elif apt list --installed 2>/dev/null | grep -qP "^shellcheck\s{1}-.*"; then
true
else
exit 255
fi
- name: Pulling git dir..
uses: actions/checkout@v2
- name: Processing files..
# Make sure that bash is used
shell: bash
run: |
cd "$GITHUB_WORKSPACE"
# Process files
## NOTICE: Do not use for loop to avoid pitfall https://mywiki.wooledge.org/BashPitfalls#pf1
git --git-dir="$GITHUB_WORKSPACE/.git" ls-files -z -- '*.bash' tools/dockerfreeze | while IFS= read -rd '' file; do
printf 'linting bash file %s\n' "$file"
shellcheck --external-sources --shell=bash "$file"
done

View File

@ -1,208 +0,0 @@
# Workflow for CPP
name: C
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.c'
jobs:
# Linting
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Installing dependencies..
run: if ! apt-list --installed cppcheck | grep -q ".*cppcheck.*"; then sudo apt install -y cppcheck; fi
- name: Linting..
run: cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.c$'); do cppcheck "$file"; done
## Valgrind test on gcc
valgrind-gcc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Installing dependencies..
run: if ! apt list --installed | grep -q ".*valgrind.*"; then sudo apt install -y valgrind; fi
- name: Linting..
run: |
make build-gcc-c
# NOTICE: This requires to input the arguments invidually
# FIXME: Use regex to gather arguments
valgrind --leak-check=full -v build/build-gcc-c/zernit-gcc-c -h -unexpected
## Valgrind on clang
valgrind-clang:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Installing dependencies..
run: if ! apt list --installed | grep -qP ".*valgrind.*"; then sudo apt install -y valgrind; fi
- name: Linting..
run: |
make build-clang-c
# NOTICE: This requires to input the arguments invidually
# FIXME: Use regex to gather arguments
valgrind --leak-check=full -v build/build-clang-c/zernit-clang-c -h -unexpected
# Kernel specific builds
build-macos-gcc-c:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-windows-gcc-c:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-macos-clang-c:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Building..
run: make build-clang-c
build-windows-clang-c:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Downloading dependencies..
run: Invoke-WebRequest -OutFile LLVM-3.7.0-win64.exe https://releases.llvm.org/3.7.0/LLVM-3.7.0-win64.exe
- name: Install dependencies..
run: |
echo FIXME_INSTALL_CLANG
EXIT
- name: Building..
run: make build-clang-c
# Docker builds
## Debian - testing
build-gcc-c-debian:
runs-on: ubuntu-latest
steps:
- uses: docker://debian/testing:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-clang-c-debian:
runs-on: ubuntu-latest
steps:
- uses: docker://debian/testing:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-c
## Fedora - latest
build-gcc-c-fedora:
runs-on: ubuntu-latest
steps:
- uses: docker://fedora/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-clang-c-fedora:
runs-on: ubuntu-latest
steps:
- uses: docker://fedora/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-c
## Archlinux - latest
build-gcc-c-archlinux:
runs-on: ubuntu-latest
steps:
- uses: docker://archlinux/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-clang-c-archlinux:
runs-on: ubuntu-latest
steps:
- uses: docker://archlinux/latest:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-c
## Gentoo stage3-amd64
build-gcc-c-gentoo:
runs-on: ubuntu-latest
steps:
- uses: docker://gentoo/stage3-amd64:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-clang-c-gentoo:
runs-on: ubuntu-latest
steps:
- uses: docker://gentoo/stage3-amd64:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-c
## Exherbo
build-gcc-c-exherbo:
runs-on: ubuntu-latest
steps:
- uses: docker://exherbo/exherbo_ci:latest
- uses: actions/checkout@v2
- name: building..
run: make build-gcc-c
build-clang-c-exherbo:
runs-on: ubuntu-latest
steps:
- uses: docker://exherbo/exherbo_ci:latest
- uses: actions/checkout@v2
- name: building..
run: make build-clang-c
# Run tests
## Exherbo (Linux representative)
check-exherbo-gcc-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- run: make check-gcc-c
check-exherbo-clang-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- run: make check-clang-c
## Windows
check-windows-gcc-cpp:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- run: make check-gcc-c
check-windows-clang-cpp:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- run: make check-clang-c
## Darwin
check-darwin-gcc-cpp:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: make check-gcc-c
check-darwin-clang-cpp:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: make check-clang-c
# Benchmarks
## Exherbo
bench-exherbo-gcc-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- name: running benchmarks..
run: make bench-gcc-cpp
bench-exherbo-clang-cpp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://exherbo/exherbo_ci:latest
- name: running benchmarks..
run: make bench-clang-cpp

View File

@ -1,30 +0,0 @@
name: Dockerfile
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.Dockerfile'
jobs:
# Linting
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Installing dependencies..
run: |
# Fix untill hadolint it available by downstream
if ! apt-cache search hadolint | grep -qP "^hadolint -"; then
# Install hadolint if not already installed through apt
if ! apt list --installed | grep -qP "^hadolint -"; then
if ! apt-cache search hadolint | grep -qP "^hadolint -.*"; then { if command -v wget >/dev/null; then apt install -y wget; fi ;} && wget https://github.com/hadolint/hadolint/releases/download/v1.17.5/hadolint-Linux-x86_64 -O /usr/bin/hadolint && { [ ! -x hadolint ] && chmod +x /usr/bin/hadolint ;}; elif apt-cache search hadolint | grep -qP "^hadolint -.*"; then apt install -y hadolint; fi
fi
fi
- name: Linting..
run: |
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.Dockerfile$'); do
printf 'checking dockerfile %s using hadolint\n' "$file"
hadolint "$file"
done

View File

@ -1,4 +1,4 @@
name: ConaIsa
name: Greetings
on: [pull_request, issues]

View File

@ -1,23 +0,0 @@
name: ConaIsa
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '*.labels\.yml$'
jobs:
labeler:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Assigning labels
if: success()
uses: crazy-max/ghaction-github-labeler@v1
with:
yaml_file: .github/labels.yml
skip_delete: false
dry_run: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

19
.github/workflows/label.yml vendored Normal file
View File

@ -0,0 +1,19 @@
# This workflow will triage pull requests and apply a label based on the
# paths that are modified in the pull request.
#
# To use this workflow, you will need to set up a .github/labeler.yml
# file with configuration. For more information, see:
# https://github.com/actions/labeler/blob/master/README.md
name: Labeler
on: [pull_request]
jobs:
label:
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v2
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"

View File

@ -1,19 +0,0 @@
# Workflow to associate labels automatically
name: Label management
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
jobs:
label:
runs-on: ubuntu-latest
steps:
# We need to checkout the repository to access the configured file (.github/label-pr.yml)
- uses: actions/checkout@v2
- name: Labeler
uses: docker://decathlon/pull-request-labeler-action:2.0.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Here we can override the path for the action configuration. If none is provided, default one is `.github/label-pr.yml`
CONFIG_PATH: ${{ secrets.GITHUB_WORKSPACE }}/.github/label-pr.yml

View File

@ -1,23 +0,0 @@
name: Markdown
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.md'
jobs:
# Linting
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Installing dependencies..
run: if ! command -v markdownlint; then sudo npm install -g markdownlint-cli; fi
- name: Linting..
run: |
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.md$'); do
printf 'linting markdown file %s' "$file"
markdownlint "$file" --ignore node_modules
done

View File

@ -1,391 +0,0 @@
# Workflow for python
name: Python
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.py'
- 'requirements.txt'
jobs:
# Linting 3.5
lint-linux-python-3_5:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.5
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-macos-python-3_5:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.5
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-windows-python-3_5:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.5
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
security-check-python-3_5:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.5
- name: Installing python dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Installing linting dependencies
run: |
if apt list --installed | grep -qP "^bandit -"; then sudo apt install -y bandit; fi
- name: Linting..
run: |
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do
printf 'checking python file %s for security issues\n' "$file"
bandit "$file"
done
# Linting 3.6
lint-linux-python-3_6:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.6
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-macos-python-3_6:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.6
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-window-python-3_6:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.6
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
security-check-python-3_6:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.6
- name: Installing python dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Installing linting dependencies
run: |
if apt list --installed | grep -qP "^bandit -"; then sudo apt install -y bandit; fi
- name: Linting..
run: |
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do
printf 'checking python file %s for security issues\n' "$file"
bandit "$file"
done
# Linting 3.7
lint-linux-python-3_7:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-macos-python-3_7:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-windows-python-3_7:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
security-check-python-3_7:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Installing python dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Installing linting dependencies
run: |
if apt list --installed | grep -qP "^bandit -"; then sudo apt install -y bandit; fi
- name: Linting..
run: |
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do
printf 'checking python file %s for security issues\n' "$file"
bandit "$file"
done
# Linting 3.8
lint-linux-python-3_8:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-macos-python-3_8:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
lint-windows-python-3_8:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Lint with flake8
run: |
pip install flake8
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pip install pytest
# FIXME: False triggers on files which names continues after set extension
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do pytest "$file"; done
security-check-python-3_8:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Configuring backend..
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Installing python dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Installing linting dependencies
run: |
if apt list --installed | grep -qP "^bandit -"; then sudo apt install -y bandit; fi
- name: Linting..
run: |
cd "$GITHUB_WORKSPACE" && for file in $(git ls-tree --name-only -r ${{ github.sha }} | grep '\.py$'); do
printf 'checking python file %s for security issues\n' "$file"
bandit "$file"
done

View File

@ -1,84 +0,0 @@
# Workflow for Rustlang
name: Rustlang
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.rs'
- Cargo.toml
jobs:
# Kernel specific builds
ubuntu-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Building..
run: cargo build
macos-build:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Building..
run: cargo build
windows-build:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Building..
run: cargo build
# Docker builds
debian-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://debian:testing
- name: Building..
run: cargo build
fedora-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://fedora:latest
- name: Building..
run: cargo build
fedora-next-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://fedora:rawhide
- name: Building..
run: cargo build
archlinux-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://archlinux:latest
- name: Building..
run: cargo build
gentoo-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: docker://gentoo/stage3-amd64:latest
- name: Building..
run: cargo build
# Run tests
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Testing..
run: cargo test
# Benchmarks
bench:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Benchmarking..
run: cargo bench

View File

@ -1,66 +0,0 @@
name: Shell
# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
on:
pull_request:
types: [synchronize, opened, reopened, ready_for_review]
paths:
- '**.sh'
jobs:
# Linting
lint:
runs-on: ubuntu-latest
container: debian:stable
steps:
- name: Installing dependencies..
run: |
# Sync repos
# Check for git
if ! apt list --installed 2>/dev/null | grep -qP "^git\/stable.*"; then
# Check if we can install git
if ! apt list | grep -qP "^git\/stable.*"; then
apt update
elif apt list | grep -qP "^git\/stable.*"; then
true
else
exit 255
fi
# Install git
apt install -y git
elif apt list --installed 2>/dev/null | grep -qP "^git\/stable.*"; then
true
else
exit 255
fi
# Check for shellcheck
if ! apt list --installed 2>/dev/null | grep -qP "^shellcheck\s{1}-.*"; then
# Check if we can install shellcheck
if ! apt list | grep -qP "^shellcheck\s{1}-.*"; then
apt update
elif apt list | grep -qP "^shellcheck\s{1}-.*"; then
true
else
exit 255
fi
# Install shellcheck
apt install -y shellcheck
elif apt list --installed 2>/dev/null | grep -qP "^shellcheck\s{1}-.*"; then
true
else
exit 255
fi
- name: Pulling git dir..
uses: actions/checkout@v2
- name: Processing files..
# Make sure that bash is used
shell: bash
run: |
cd "$GITHUB_WORKSPACE"
# Process files
## NOTICE: Do not use for loop to avoid pitfall https://mywiki.wooledge.org/BashPitfalls#pf1
git --git-dir="$GITHUB_WORKSPACE/.git" ls-files -z -- '*.sh' | while IFS= read -rd '' file; do
printf 'linting shell file %s\n' "$file"
shellcheck --external-sources --shell=sh "$file"
done

19
.github/workflows/stale.yml vendored Normal file
View File

@ -0,0 +1,19 @@
name: Mark stale issues and pull requests
on:
schedule:
- cron: "0 0 * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'Stale issue message'
stale-pr-message: 'Stale pull request message'
stale-issue-label: 'no-issue-activity'
stale-pr-label: 'no-pr-activity'

View File

@ -1,17 +0,0 @@
name: Staler
on:
schedule:
- cron: "0 0 * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'FIXME: Stale issue message (https://github.com/RXT0112/Zernit/edit/master/.github/workflows/stale.yml)'
stale-pr-message: 'FIXME: Stale pull request message (https://github.com/RXT0112/Zernit/edit/master/.github/workflows/stale.yml)'
stale-issue-label: 'no-issue-activity'
stale-pr-label: 'no-pr-activity'

19
.gitignore vendored
View File

@ -1,18 +1 @@
# FIXME: Move in '.git/info/exclude' once branch is determined ?
# Autogenerated by Cargo no need to keep in repo
Cargo.lock
# Exclude all backup files
*.bak
*.bk
# Exclude build result
/target
/build
# Ignore vendor files
/vendor
# Do not include clap benches in the commits
/benches/rustlang/claprs*
target

4
.gitmodules vendored Normal file
View File

@ -0,0 +1,4 @@
[submodule "tests"]
path = tests
url = https://github.com/RXT0113/HELL.git
branch = master

View File

@ -1,34 +1,6 @@
privileged: true
image:
file: gitpod/debian.Dockerfile
file: gitpod/gitpod.Dockerfile
# FIXME: Change gitpod user on GITPOD_GIT_USER_NAME env value
tasks:
# Does not accept Quotation without '|' ?
- init: |
printf 'FIXME: %s\n' "Get rid of me"
command: |
printf 'FIXME: %s\n' "This is a hotfix for https://github.com/gitpod-io/gitpod/issues/1252 manipulating PS1 env var"
# FIXME: The color of second line does not transfer to the environment unless Ctrl+C is pressed
export PS1="\033[1m\e[38;5;201m[ \t : \w : EXIT \$? ]\033[0m\e[38;5;011m\n\u@gitpod \\$ \[$(tput sgr0)\]"
# ^^^^^^^ - bolt
# ^^^^^^^^^^^^ - Purple color
# ^^^^^^ - remove bolt
# ^^^^^^^^^^^ - Gold color
clear
vscode:
extensions:
- kalitaalexey.vscode-rust@0.4.2:iw09QffwKU6Xcxr7C2zalA==
- Swellaby.vscode-rust-test-adapter@0.11.0:Xg+YeZZQiVpVUsIkH+uiiw==
- bungcip.better-toml@0.3.2:3QfgGxxYtGHfJKQU7H0nEw==
- hbenl.vscode-test-explorer@2.15.0:koqDUMWDPJzELp/hdS/lWw==
- belfz.search-crates-io@1.2.1:kSLnyrOhXtYPjQpKnMr4eQ==
- serayuzgur.crates@0.4.7:HMkoguLcXp9M3ud7ac3eIw==
- timonwong.shellcheck@0.9.0:hsU/Rd39aqPYowTqL+DbXg==
- krosf.vscode-valgrind@0.0.1:YTn5lOY8OnPKJYDqJPr/Sg==
- matklad.rust-analyzer@0.1.20200217:zozmBmOg1N91pRISIsYXBg==
- exiasr.hadolint@0.3.0:/FkAW3eTb+z9O7VZAyAa0w==
- DavidAnson.vscode-markdownlint@0.34.0:l4DL7iPpo7DdhfUHIUtcuQ==
- yzhang.markdown-all-in-one@2.7.0:5+DmuGcePw8L9PtfgOAAHg==
ports:
- port: 6080
onOpen: open-preview

View File

@ -1,12 +0,0 @@
ignored:
- DL3007 # Usage of latest version is expected
- DL3008 # Pinning specific version on apt is not sane
- DL3015 # We don't mind recommended packages
- DL4001 # Allow usage of curl and wget
- DL4006 # False-trigger on /bin/sh usage?
trustedRegistries:
- docker.io
- debian
- gitpod
- hadolint

View File

@ -1,8 +0,0 @@
// FIXME-LINT(18032020): Outputs invalid errors in gitpod
{
// We do not need newlines on EOF
"single-trailing-newline": false,
// We don't care fore line lenght due to the softwrap
"line-length": false
}

View File

@ -1,3 +0,0 @@
Configuration directory for [theia](https://github.com/eclipse-theia/theia)
Theia is also used by gitpod

View File

@ -1,19 +0,0 @@
{
"editor.wordWrap": "on",
// To show invisibles
"editor.renderWhitespace": "all",
"editor.tabSize": 2,
"editor.tabCompletion": "on",
"setup.dontask": true,
// rustlang
"crates.upToDateDecorator": "",
"rust.wait_to_build": 0,
// FIXME: Expand nproc command here
// NOTICE: Gitpod is currently (130220) limited on 8 threads
// FIXME: We are unable to shot datatype helpers (https://github.com/gitpod-io/gitpod/issues/1200)
"rust.jobs": 8,
"rust.build_on_save": true,
"rust.target_dir": "build/rustlang",
"rust-analyzer.displayInlayHints": true,
"rust-analyzer.highlightingOn": true,
}

View File

@ -1,247 +0,0 @@
# Copyright 2019 Jacob Hrbek <kreyren@rixotstudio.cz>
# Distributed under the terms of the GNU General Public License v3 (https://www.gnu.org/licenses/gpl-3.0.en.html) or later
# FIXME-LINT(18032020): Outputs wrong highlights in gitpod
# Based in part upon 'travis.yml' from rsplib (https://raw.githubusercontent.com/dreibh/rsplib/master/.travis.yml), which is:
# Copyright (C) 2018-2019 by Thomas Dreibholz <dreibh@iem.uni-due.de> as GPLv3 or any other GPL at your option
sudo: required
# Use matrix to run tests on different environments
matrix:
include:
## BUILD ##
# Exherbo Linux
# Exherbo with GCC
- name: "Exherbo Linux with GCC"
os: linux
dist: bionic
group: exherbo
cache:
directories:
- /var/db/paludis
env:
DOCKER="exherbo_ci:latest"
VARIANT="exherbo"
TOOL="build"
COMPILER_C="gcc"
COMPILER_CXX="g++"
# Exherbo with Clang
- name: "Exherbo Linux with Clang"
os: linux
dist: bionic
group: exherbo
cache:
directories:
- /var/db/paludis
env:
DOCKER="exherbo_ci:latest"
VARIANT="exherbo"
TOOL="build"
COMPILER_C="clang"
COMPILER_CXX="clang++"
# Ubuntu Linux
# Ubuntu 19.10 (Eoan Ermine) with GCC
- name: "Ubuntu 19.10 (Eoan Ermine) with GCC"
os: linux
cache:
directories:
- /var/cache/apt/
dist: bionic
group: travis_latest
env:
DOCKER="ubuntu:eoan"
VARIANT="ubuntu-19.10"
TOOL="build"
COMPILER_C="gcc"
COMPILER_CXX="g++"
REPOSITORY="https://github.com/RXT0112/Zernit.git"
PACKAGES="git make cargo rustc"
# Ubuntu 19.10 (Eoan Ermine) with Clang
- name: "Ubuntu 19.10 (Eoan Ermine) with Clang"
os: linux
cache:
directories:
- /var/cache/apt/
dist: bionic
group: travis_latest
env:
DOCKER="ubuntu:eoan"
VARIANT="ubuntu-19.10"
TOOL="build"
COMPILER_C="clang"
COMPILER_CXX="clang++"
REPOSITORY="https://github.com/RXT0112/Zernit.git"
PACKAGES="git make cargo rustc"
# Debian Linux
# Debian Testing
- name: "Debian Testing with GCC"
os: linux
dist: bionic
group: travis_latest
env:
DOCKER="debian:testing"
VARIANT="debian-testing"
TOOL="build"
COMPILER_C="gcc"
COMPILER_CXX="g++"
REPOSITORY="https://github.com/RXT0112/Zernit.git"
PACKAGES="rustc cargo git make pkg-config libssl-dev"
- name: "Debian Testing with Clang"
os: linux
dist: bionic
group: travis_latest
env:
DOCKER="debian:testing"
VARIANT="debian-testing"
TOOL="build"
COMPILER_C="clang"
COMPILER_CXX="clang++"
REPOSITORY="https://github.com/RXT0112/Zernit.git"
PACKAGES="rustc cargo git make pkg-config libssl-dev"
# # Debian Sid
# - name: "Debian Sid with GCC"
# os: linux
# dist: bionic
# group: travis_latest
# env:
# DOCKER="debian:sid"
# VARIANT="debian"
# TOOL="build"
# COMPILER_C="gcc"
# COMPILER_CXX="g++"
# REPOSITORY="https://github.com/RXT0112/Zernit.git"
# PACKAGES="rustc cargo build-essentials make"
# - name: "Debian Sid with Clang"
# os: linux
# dist: bionic
# group: travis_latest
# env:
# DOCKER="debian:sid"
# VARIANT="debian"
# TOOL="build"
# COMPILER_C="clang"
# COMPILER_CXX="clang++"
# REPOSITORY="https://github.com/RXT0112/Zernit.git"
# PACKAGES="rustc cargo build-essentials make"
# # FreeBSD
# # FreeBSD 12.0-RELEASE
# - name: "FreeBSD 12.0-RELEASE with Clang"
# os: linux
# dist: bionic
# group: travis_latest
# env:
# QEMU="FreeBSD"
# VARIANT="12.0-RELEASE"
# TOOL="build"
# COMPILER_C="clang"
# COMPILER_CXX="clang++"
# - name: "FreeBSD 12.0-RELEASE with GCC"
# os: linux
# dist: bionic
# group: travis_latest
# env:
# QEMU="FreeBSD"
# VARIANT="12.0-RELEASE"
# TOOL="build"
# COMPILER_C="gcc"
# COMPILER_CXX="g++"
# FIXME: MacOS needs refactor of C programs to be compatible (https://travis-ci.org/Kreyrock/Kreyrock/jobs/620509927?utm_medium=notification&utm_source=github_status)
# MacOS X
## MacOS 10.14
- name: "MacOS 10.14, xcode11.2 with clang"
os: osx
cache:
- /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula
osx_image: xcode11.2
compiler: clang
group: travis_latest
env:
TOOL="build"
- name: "MacOS 10.14, xcode11.2 with gcc"
os: osx
cache:
- /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula
osx_image: xcode11.2
compiler: gcc
group: travis_latest
env:
TOOL="build"
## MacOS 10.14.4
- name: "MacOS 10.14.4, xcode10.3 with clang"
os: osx
cache:
- /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula
osx_image: xcode10.3
compiler: clang
group: travis_latest
env:
TOOL="build"
- name: "MacOS 10.14.4, xcode10.3 with gcc"
os: osx
cache:
- /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula
osx_image: xcode10.3
compiler: gcc
group: travis_latest
env:
TOOL="build"
## MacOS 10.13
- name: "MacOS 10.13, xcode9.4 with clang"
os: osx
cache:
- /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula
osx_image: xcode9.4
compiler: clang
group: travis_latest
env:
TOOL="build"
- name: "MacOS 10.13, xcode9.4 with gcc"
os: osx
cache:
- /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula
osx_image: xcode9.4
compiler: gcc
group: travis_latest
env:
TOOL="build"
# Others
# Default linux
- name: "Linux, default check"
os: linux
dist: bionic
group: travis_latest
env:
TOOL="check"
# Windows
# - name: "Windows build"
# os: windows
# env:
# TOOL="build"
before-install:
- QA/travis-ci/before-install.sh
install:
- QA/travis-ci/install.sh
script:
- QA/travis-ci/test.sh
- QA/travis-ci/build.sh

View File

@ -1,3 +1,636 @@
All rights reserved by Jacob Hrbek <kreyren@rixotstudio.cz> in 12/07/2018 unless explicitedly specified otherwise.
# GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
This repository is designed to be used with a licences specified in src/licences that are custom made for this project and projects alike to define a new standard.
Copyright (C) 2007 [Free Software Foundation, Inc.](http://fsf.org/)
Everyone is permitted to copy and distribute verbatim copies of this license
document, but changing it is not allowed.
## Preamble
The GNU General Public License is a free, copyleft license for software and
other kinds of works.
The licenses for most software and other practical works are designed to take
away your freedom to share and change the works. By contrast, the GNU General
Public License is intended to guarantee your freedom to share and change all
versions of a program--to make sure it remains free software for all its users.
We, the Free Software Foundation, use the GNU General Public License for most
of our software; it applies also to any other work released this way by its
authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our
General Public Licenses are designed to make sure that you have the freedom to
distribute copies of free software (and charge for them if you wish), that you
receive source code or can get it if you want it, that you can change the
software or use pieces of it in new free programs, and that you know you can do
these things.
To protect your rights, we need to prevent others from denying you these rights
or asking you to surrender the rights. Therefore, you have certain
responsibilities if you distribute copies of the software, or if you modify it:
responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for
a fee, you must pass on to the recipients the same freedoms that you received.
You must make sure that they, too, receive or can get the source code. And you
must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps:
1. assert copyright on the software, and
2. offer you this License giving you legal permission to copy, distribute
and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that
there is no warranty for this free software. For both users' and authors' sake,
the GPL requires that modified versions be marked as changed, so that their
problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified
versions of the software inside them, although the manufacturer can do so. This
is fundamentally incompatible with the aim of protecting users' freedom to
change the software. The systematic pattern of such abuse occurs in the area of
products for individuals to use, which is precisely where it is most
unacceptable. Therefore, we have designed this version of the GPL to prohibit
the practice for those products. If such problems arise substantially in other
domains, we stand ready to extend this provision to those domains in future
versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States
should not allow patents to restrict development and use of software on
general-purpose computers, but in those that do, we wish to avoid the special
danger that patents applied to a free program could make it effectively
proprietary. To prevent this, the GPL assures that patents cannot be used to
render the program non-free.
The precise terms and conditions for copying, distribution and modification
follow.
## TERMS AND CONDITIONS
### 0. Definitions.
*This License* refers to version 3 of the GNU General Public License.
*Copyright* also means copyright-like laws that apply to other kinds of works,
such as semiconductor masks.
*The Program* refers to any copyrightable work licensed under this License.
Each licensee is addressed as *you*. *Licensees* and *recipients* may be
individuals or organizations.
To *modify* a work means to copy from or adapt all or part of the work in a
fashion requiring copyright permission, other than the making of an exact copy.
The resulting work is called a *modified version* of the earlier work or a work
*based on* the earlier work.
A *covered work* means either the unmodified Program or a work based on the
Program.
To *propagate* a work means to do anything with it that, without permission,
would make you directly or secondarily liable for infringement under applicable
copyright law, except executing it on a computer or modifying a private copy.
Propagation includes copying, distribution (with or without modification),
making available to the public, and in some countries other activities as well.
To *convey* a work means any kind of propagation that enables other parties to
make or receive copies. Mere interaction with a user through a computer
network, with no transfer of a copy, is not conveying.
An interactive user interface displays *Appropriate Legal Notices* to the
extent that it includes a convenient and prominently visible feature that
1. displays an appropriate copyright notice, and
2. tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the work
under this License, and how to view a copy of this License.
If the interface presents a list of user commands or options, such as a menu, a
prominent item in the list meets this criterion.
### 1. Source Code.
The *source code* for a work means the preferred form of the work for making
modifications to it. *Object code* means any non-source form of a work.
A *Standard Interface* means an interface that either is an official standard
defined by a recognized standards body, or, in the case of interfaces specified
for a particular programming language, one that is widely used among developers
working in that language.
The *System Libraries* of an executable work include anything, other than the
work as a whole, that (a) is included in the normal form of packaging a Major
Component, but which is not part of that Major Component, and (b) serves only
to enable use of the work with that Major Component, or to implement a Standard
Interface for which an implementation is available to the public in source code
form. A *Major Component*, in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system (if any) on
which the executable work runs, or a compiler used to produce the work, or an
object code interpreter used to run it.
The *Corresponding Source* for a work in object code form means all the source
code needed to generate, install, and (for an executable work) run the object
code and to modify the work, including scripts to control those activities.
However, it does not include the work's System Libraries, or general-purpose
tools or generally available free programs which are used unmodified in
performing those activities but which are not part of the work. For example,
Corresponding Source includes interface definition files associated with source
files for the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require, such as
by intimate data communication or control flow between those subprograms and
other parts of the work.
The Corresponding Source need not include anything that users can regenerate
automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
### 2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on
the Program, and are irrevocable provided the stated conditions are met. This
License explicitly affirms your unlimited permission to run the unmodified
Program. The output from running a covered work is covered by this License only
if the output, given its content, constitutes a covered work. This License
acknowledges your rights of fair use or other equivalent, as provided by
copyright law.
You may make, run and propagate covered works that you do not convey, without
conditions so long as your license otherwise remains in force. You may convey
covered works to others for the sole purpose of having them make modifications
exclusively for you, or provide you with facilities for running those works,
provided that you comply with the terms of this License in conveying all
material for which you do not control copyright. Those thus making or running
the covered works for you must do so exclusively on your behalf, under your
direction and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10 makes it
unnecessary.
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure
under any applicable law fulfilling obligations under article 11 of the WIPO
copyright treaty adopted on 20 December 1996, or similar laws prohibiting or
restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention is
effected by exercising rights under this License with respect to the covered
work, and you disclaim any intention to limit operation or modification of the
work as a means of enforcing, against the work's users, your or third parties'
legal rights to forbid circumvention of technological measures.
### 4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it,
in any medium, provided that you conspicuously and appropriately publish on
each copy an appropriate copyright notice; keep intact all notices stating that
this License and any non-permissive terms added in accord with section 7 apply
to the code; keep intact all notices of the absence of any warranty; and give
all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may
offer support or warranty protection for a fee.
### 5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it
from the Program, in the form of source code under the terms of section 4,
provided that you also meet all of these conditions:
- a) The work must carry prominent notices stating that you modified it, and
giving a relevant date.
- b) The work must carry prominent notices stating that it is released under
this License and any conditions added under section 7. This requirement
modifies the requirement in section 4 to *keep intact all notices*.
- c) You must license the entire work, as a whole, under this License to
anyone who comes into possession of a copy. This License will therefore
apply, along with any applicable section 7 additional terms, to the whole
of the work, and all its parts, regardless of how they are packaged. This
License gives no permission to license the work in any other way, but it
does not invalidate such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your work need
not make them do so.
A compilation of a covered work with other separate and independent works,
which are not by their nature extensions of the covered work, and which are not
combined with it such as to form a larger program, in or on a volume of a
storage or distribution medium, is called an *aggregate* if the compilation and
its resulting copyright are not used to limit the access or legal rights of the
compilation's users beyond what the individual works permit. Inclusion of a
covered work in an aggregate does not cause this License to apply to the other
parts of the aggregate.
### 6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4
and 5, provided that you also convey the machine-readable Corresponding Source
under the terms of this License, in one of these ways:
- a) Convey the object code in, or embodied in, a physical product (including
a physical distribution medium), accompanied by the Corresponding Source
fixed on a durable physical medium customarily used for software
interchange.
- b) Convey the object code in, or embodied in, a physical product (including
a physical distribution medium), accompanied by a written offer, valid for
at least three years and valid for as long as you offer spare parts or
customer support for that product model, to give anyone who possesses the
object code either
1. a copy of the Corresponding Source for all the software in the product
that is covered by this License, on a durable physical medium
customarily used for software interchange, for a price no more than your
reasonable cost of physically performing this conveying of source, or
2. access to copy the Corresponding Source from a network server at no
charge.
- c) Convey individual copies of the object code with a copy of the written
offer to provide the Corresponding Source. This alternative is allowed only
occasionally and noncommercially, and only if you received the object code
with such an offer, in accord with subsection 6b.
- d) Convey the object code by offering access from a designated place
(gratis or for a charge), and offer equivalent access to the Corresponding
Source in the same way through the same place at no further charge. You
need not require recipients to copy the Corresponding Source along with the
object code. If the place to copy the object code is a network server, the
Corresponding Source may be on a different server operated by you or a
third party) that supports equivalent copying facilities, provided you
maintain clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the Corresponding
Source, you remain obligated to ensure that it is available for as long as
needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission, provided you
inform other peers where the object code and Corresponding Source of the
work are being offered to the general public at no charge under subsection
6d.
A separable portion of the object code, whose source code is excluded from the
Corresponding Source as a System Library, need not be included in conveying the
object code work.
A *User Product* is either
1. a *consumer product*, which means any tangible personal property which is
normally used for personal, family, or household purposes, or
2. anything designed or sold for incorporation into a dwelling.
In determining whether a product is a consumer product, doubtful cases shall be
resolved in favor of coverage. For a particular product received by a
particular user, *normally used* refers to a typical or common use of that
class of product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected to use,
the product. A product is a consumer product regardless of whether the product
has substantial commercial, industrial or non-consumer uses, unless such uses
represent the only significant mode of use of the product.
*Installation Information* for a User Product means any methods, procedures,
authorization keys, or other information required to install and execute
modified versions of a covered work in that User Product from a modified
version of its Corresponding Source. The information must suffice to ensure
that the continued functioning of the modified object code is in no case
prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as part of a
transaction in which the right of possession and use of the User Product is
transferred to the recipient in perpetuity or for a fixed term (regardless of
how the transaction is characterized), the Corresponding Source conveyed under
this section must be accompanied by the Installation Information. But this
requirement does not apply if neither you nor any third party retains the
ability to install modified object code on the User Product (for example, the
work has been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates for a
work that has been modified or installed by the recipient, or for the User
Product in which it has been modified or installed. Access to a network may be
denied when the modification itself materially and adversely affects the
operation of the network or violates the rules and protocols for communication
across the network.
Corresponding Source conveyed, and Installation Information provided, in accord
with this section must be in a format that is publicly documented (and with an
implementation available to the public in source code form), and must require
no special password or key for unpacking, reading or copying.
### 7. Additional Terms.
*Additional permissions* are terms that supplement the terms of this License by
making exceptions from one or more of its conditions. Additional permissions
that are applicable to the entire Program shall be treated as though they were
included in this License, to the extent that they are valid under applicable
law. If additional permissions apply only to part of the Program, that part may
be used separately under those permissions, but the entire Program remains
governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any
additional permissions from that copy, or from any part of it. (Additional
permissions may be written to require their own removal in certain cases when
you modify the work.) You may place additional permissions on material, added
by you to a covered work, for which you have or can give appropriate copyright
permission.
Notwithstanding any other provision of this License, for material you add to a
covered work, you may (if authorized by the copyright holders of that material)
supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the terms of
sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or author
attributions in that material or in the Appropriate Legal Notices displayed
by works containing it; or
- c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in reasonable
ways as different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors or authors
of the material; or
- e) Declining to grant rights under trademark law for use of some trade
names, trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that material by
anyone who conveys the material (or modified versions of it) with
contractual assumptions of liability to the recipient, for any liability
that these contractual assumptions directly impose on those licensors and
authors.
All other non-permissive additional terms are considered *further restrictions*
within the meaning of section 10. If the Program as you received it, or any
part of it, contains a notice stating that it is governed by this License along
with a term that is a further restriction, you may remove that term. If a
license document contains a further restriction but permits relicensing or
conveying under this License, you may add to a covered work material governed
by the terms of that license document, provided that the further restriction
does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place,
in the relevant source files, a statement of the additional terms that apply to
those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a
separately written license, or stated as exceptions; the above requirements
apply either way.
### 8. Termination.
You may not propagate or modify a covered work except as expressly provided
under this License. Any attempt otherwise to propagate or modify it is void,
and will automatically terminate your rights under this License (including any
patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a
particular copyright holder is reinstated
- a) provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and
- b) permanently, if the copyright holder fails to notify you of the
violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated
permanently if the copyright holder notifies you of the violation by some
reasonable means, this is the first time you have received notice of violation
of this License (for any work) from that copyright holder, and you cure the
violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses
of parties who have received copies or rights from you under this License. If
your rights have been terminated and not permanently reinstated, you do not
qualify to receive new licenses for the same material under section 10.
### 9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy
of the Program. Ancillary propagation of a covered work occurring solely as a
consequence of using peer-to-peer transmission to receive a copy likewise does
not require acceptance. However, nothing other than this License grants you
permission to propagate or modify any covered work. These actions infringe
copyright if you do not accept this License. Therefore, by modifying or
propagating a covered work, you indicate your acceptance of this License to do
so.
### 10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a
license from the original licensors, to run, modify and propagate that work,
subject to this License. You are not responsible for enforcing compliance by
third parties with this License.
An *entity transaction* is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered work
results from an entity transaction, each party to that transaction who receives
a copy of the work also receives whatever licenses to the work the party's
predecessor in interest had or could give under the previous paragraph, plus a
right to possession of the Corresponding Source of the work from the
predecessor in interest, if the predecessor has it or can get it with
reasonable efforts.
You may not impose any further restrictions on the exercise of the rights
granted or affirmed under this License. For example, you may not impose a
license fee, royalty, or other charge for exercise of rights granted under this
License, and you may not initiate litigation (including a cross-claim or
counterclaim in a lawsuit) alleging that any patent claim is infringed by
making, using, selling, offering for sale, or importing the Program or any
portion of it.
### 11. Patents.
A *contributor* is a copyright holder who authorizes use under this License of
the Program or a work on which the Program is based. The work thus licensed is
called the contributor's *contributor version*.
A contributor's *essential patent claims* are all patent claims owned or
controlled by the contributor, whether already acquired or hereafter acquired,
that would be infringed by some manner, permitted by this License, of making,
using, or selling its contributor version, but do not include claims that would
be infringed only as a consequence of further modification of the contributor
version. For purposes of this definition, *control* includes the right to grant
patent sublicenses in a manner consistent with the requirements of this
License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent
license under the contributor's essential patent claims, to make, use, sell,
offer for sale, import and otherwise run, modify and propagate the contents of
its contributor version.
In the following three paragraphs, a *patent license* is any express agreement
or commitment, however denominated, not to enforce a patent (such as an express
permission to practice a patent or covenant not to sue for patent
infringement). To *grant* such a patent license to a party means to make such
an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the
Corresponding Source of the work is not available for anyone to copy, free of
charge and under the terms of this License, through a publicly available
network server or other readily accessible means, then you must either
1. cause the Corresponding Source to be so available, or
2. arrange to deprive yourself of the benefit of the patent license for this
particular work, or
3. arrange, in a manner consistent with the requirements of this License, to
extend the patent license to downstream recipients.
*Knowingly relying* means you have actual knowledge that, but for the patent
license, your conveying the covered work in a country, or your recipient's use
of the covered work in a country, would infringe one or more identifiable
patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you
convey, or propagate by procuring conveyance of, a covered work, and grant a
patent license to some of the parties receiving the covered work authorizing
them to use, propagate, modify or convey a specific copy of the covered work,
then the patent license you grant is automatically extended to all recipients
of the covered work and works based on it.
A patent license is *discriminatory* if it does not include within the scope of
its coverage, prohibits the exercise of, or is conditioned on the non-exercise
of one or more of the rights that are specifically granted under this License.
You may not convey a covered work if you are a party to an arrangement with a
third party that is in the business of distributing software, under which you
make payment to the third party based on the extent of your activity of
conveying the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory patent
license
- a) in connection with copies of the covered work conveyed by you (or copies
made from those copies), or
- b) primarily for and in connection with specific products or compilations
that contain the covered work, unless you entered into that arrangement, or
that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied
license or other defenses to infringement that may otherwise be available to
you under applicable patent law.
### 12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not excuse
you from the conditions of this License. If you cannot convey a covered work so
as to satisfy simultaneously your obligations under this License and any other
pertinent obligations, then as a consequence you may not convey it at all. For
example, if you agree to terms that obligate you to collect a royalty for
further conveying from those to whom you convey the Program, the only way you
could satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
### 13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to
link or combine any covered work with a work licensed under version 3 of the
GNU Affero General Public License into a single combined work, and to convey
the resulting work. The terms of this License will continue to apply to the
part which is the covered work, but the special requirements of the GNU Affero
General Public License, section 13, concerning interaction through a network
will apply to the combination as such.
### 14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU
General Public License from time to time. Such new versions will be similar in
spirit to the present version, but may differ in detail to address new problems
or concerns.
Each version is given a distinguishing version number. If the Program specifies
that a certain numbered version of the GNU General Public License *or any later
version* applies to it, you have the option of following the terms and
conditions either of that numbered version or of any later version published by
the Free Software Foundation. If the Program does not specify a version number
of the GNU General Public License, you may choose any version ever published by
the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the
GNU General Public License can be used, that proxy's public statement of
acceptance of a version permanently authorizes you to choose that version for
the Program.
Later license versions may give you additional or different permissions.
However, no additional obligations are imposed on any author or copyright
holder as a result of your choosing to follow a later version.
### 15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
PARTIES PROVIDE THE PROGRAM *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
### 16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS
PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
### 17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot
be given local legal effect according to their terms, reviewing courts shall
apply local law that most closely approximates an absolute waiver of all civil
liability in connection with the Program, unless a warranty or assumption of
liability accompanies a copy of the Program in return for a fee.
## END OF TERMS AND CONDITIONS ###
### How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible
use to the public, the best way to achieve this is to make it free software
which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach
them to the start of each source file to most effectively state the exclusion
of warranty; and each file should have at least the *copyright* line and a
pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like
this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w` and `show c` should show the appropriate
parts of the General Public License. Of course, your program's commands might
be different; for a GUI interface, you would use an *about box*.
You should also get your employer (if you work as a programmer) or school, if
any, to sign a *copyright disclaimer* for the program, if necessary. For more
information on this, and how to apply and follow the GNU GPL, see
[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
The GNU General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may consider
it more useful to permit linking proprietary applications with the library. If
this is what you want to do, use the GNU Lesser General Public License instead
of this License. But first, please read
[http://www.gnu.org/philosophy/why-not-lgpl.html](http://www.gnu.org/philosophy/why-not-lgpl.html).

150
Makefile
View File

@ -1,137 +1,23 @@
# FIXME: in-code docs needed
# FIXME: Windows doesn't support makefiles natively -> if you have a better method then please MR it or make an issue
## Syntax capture ##
all:
@ printf '%s\n' "Unknown option '$1' parsed in target all"
@ exit 2
@ printf '%s\n' "Unknown option parsed in target all" ; exit 2
## UNLEASH RUNTIME ##
run:
@ cargo run \
--jobs "$$(nproc)" \
--target-dir target \
--manifest-path="$$(pwd)/src/Cargo.toml"
unleash-elisp:
@ src/RXT0112-1/downstream-classes/zeres-0/elisp/UNLEASH.el
experiment:
@ cargo run "src/experiment.rs" \
--jobs "$$(nproc)" \
--target-dir target \
--manifest-path="$$(pwd)/src/Cargo.toml"
## BUILD ##
# All build targets are expected in 'build/build-LANG' where 'LANG' is the unique identifier of the language used
# FIXME: Replace 'exit 1' with helpful messages
build:
@ cargo build \
--jobs "$$(nproc)" \
--target-dir target \
--manifest-path="$$(pwd)/src/Cargo.toml"
build: build-rustlang build-clang-c build-gcc-c build-gcc-ccp build-clang build-brainfuck build-python build-vlang build-golang
@ printf 'WARN: %s\n' "You are abould to build all targets on multilang project"
# FIXME: Build in '$repodir/build/build-rustlang' instead of '$repodir/target' for multilang support
build-rustlang:
@ cargo build --verbose
# FIXME: Add logic
build-clang-c:
@ # Make a build directory
@ [ ! -d build ] && { mkdir build || exit 1 ;} || exit 0
@ [ ! -d build/build-clang-c ] && { mkdir build/build-clang-c || exit 1 ;} || exit 0
@ # Compilation
@ [ ! -f build/build-clang-c/zernit-clang-c ] && { clang src/bin/main.c -o build/build-clang-c/zernit-clang-c || exit 1 ;} || exit 0
@ printf '%s\n' "Compilation of target for clang-c finished"
build-gcc-c:
@ # Make a build directory
@ [ ! -d build ] && { mkdir build || exit 1 ;} || exit 0
@ [ ! -d build/target-gcc-c ] && { mkdir build/build-gcc-c || exit 1 ;} || exit 0
@ # Compilation
@ [ ! -f build/build-gcc-c/zernit-gcc-c ] && { gcc src/bin/main.c -o build/build-gcc-c/zernit-gcc-c || exit 1 ;} || exit 0
@ printf '%s\n' "Compilation of target for gcc-c finished"
# FIXME: Replace 'exit 1' with helpful messages
build-gcc-ccp:
@ # Make a build directory
@ [ ! -d build ] && { mkdir build || exit 1 ;}
@ [ ! -d build/target-gcc ] && { mkdir build/build-gcc || exit 1 ;}
@ # Compilation
@ [ ! -f build/build-gcc ] && { gcc src/bin/main.c -o build/build-gcc/gcc-zernit || exit 1 ;}
@ printf '%s\n' "Compilation of target for gcc finished"
build-clang-ccp:
@ printf 'FIXME: %s\n' "translate zernit in clang"
@ exit 1
build-brainfuck:
@ printf 'FIXME: %s\n' "translate zernit in brainfuck"
@ exit 1
# FIXME: requires python3.6+ and pip3
build-python:
@ pip3 install -r requirements.txt
build-vlang:
@ [ ! -d build ] && mkdir build
@ [ ! -d build/build-vlang ] && mkdir build/build-vlang
@ /opt/vlang/v -o build/build-vlang/zernit-vlang src/bin/main.v
build-golang:
@ [ ! -d build ] && mkdir build
@ [ ! -d build/build-golang ] && mkdir build/build-golang
@ go build -o build/build-golang/zernit-golang src/bin/main.go
## CHECK/TESTS ##
check:
@ printf 'FIXME: %s\n' "Check all targets if executed"
@ exit 1
check-gcc-c:
@ printf 'FIXME: %s\n' "Add tests for gc"
@ exit 1
check-clang-c:
@ printf 'FIXME: %s\n' "Add tests for gcc"
@ exit 1
check-gcc-ccp:
@ printf 'FIXME: %s\n' "Add tests for clang"
@ exit 1
check-python:
@ printf 'FIXME: %s\n' "Add tests for python"
@ exit 1
check-rustlang:
@ printf 'FIXME: %s\n' "Add tests for rustlang"
@ exit 1
check-brainfuck:
@ printf 'FIXME: %s\n' "Add tests for brainfuck"
@ exit 1
check-shell:
@ printf 'FIXME: %s\n' "Add tests for shell"
@ exit 1
check-bash:
@ printf 'FIXME: %s\n' "Add tests for bash"
@ exit 1
check-vlang:
@ printf 'FIXME: %s\n' "Add tests for vlang"
@ exit 1
## BENCHES ##
# FIXME: Run all benches if this is executed
bench: bench-rustlang
# FIXME: Run vendor and
bench-rustlang:
@ cargo bench
## CLEAN ##
clean: clean-vendor clean-benches
@ [ -d build ] && { rm -rf build || exit 1 ;} || exit 0
@ printf '%s\n' "Build directory has been cleaned"
clean-vendor:
@ # FIXME: Output helpful message if directory doesn't exists
@ [ -d vendor ] && { rm -rf vendor || exit 1 ;} || exit 0
release:
@ printf '%s\n' "FIXME: Release logic needed" ; exit 1

View File

@ -1,3 +0,0 @@
# RXT0112
WIP

View File

@ -1,2 +0,0 @@
# Configuration file for bandit (security check for python)

View File

@ -1,11 +0,0 @@
Stub for new website implementation
Expecting
- User database to handle the workflow
- Method to host repositories
- sourcehut implementation
- Social-network like platform so that users can communicate with each other
efficency is a concer when php 8.0 and golang seems to be the best candidates
for golang https://github.com/gogs/gogs could be forked?

8
docs/.gitignore vendored
View File

@ -1,8 +0,0 @@
.jekyll-cache/
!.gitignore
!.gitmodules
*~
components/
_site/

View File

@ -1,9 +0,0 @@
image:
file: gitpod/gitpod.Dockerfile
ports:
- port: 4000
onOpen: open-preview
tasks:
- init: gem install jekyll

View File

@ -1,21 +0,0 @@
The MIT License (MIT)
Copyright (c) [year] [fullname]
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.

View File

@ -1,22 +0,0 @@
SRC = $(wildcard lib/*/*.js)
HTML = $(wildcard lib/*/*.html)
TEMPLATES = $(HTML:.html=.js)
LESS = $(wildcard lib/*/*.less)
CSS = $(LESS:.less=.css)
build: components $(SRC) $(TEMPLATES) $(CSS)
@component build --verbose --out . --name assets
components: component.json
@component install
%.js: %.html
@component convert $<
%.css: %.less
@lessc $< $@
clean:
rm -fr build components $(TEMPLATES)
.PHONY: clean

View File

@ -1,68 +0,0 @@
## The "What ?" and the "Why ?"
**Carte** is a simple Jekyll based documentation website for APIs. It is designed as a boilerplate to build your own documentation and is heavily inspired from [Swagger](http://swagger.wordnik.com/) and [I/O docs](http://www.mashery.com/product/io-docs). Fork it, add specifications for your APIs calls and customize the theme. <small>Go ahead, see if we care.</small>
We built **Carte** because the existing options (Swagger and the likes) were trying to do too much and did not match our needs:
1. Most of our API calls are sending JSON objects, as opposed to a series of parameters,
1. Being able to query the real API is nice, but running anything but `GET` calls can get tricky ("What do you mean I deleted my stuff? I was just trying out the API calls!"),
1. Overall, setting up a separate server for what really requires a good static documentation seemed overkill.
The real value of **Carte** is its structure for describing APIs, not its underlying technical stack (or lack-thereof). In a nutshell; **we built a static template for your API documentation, feel free to re-use it**.
## Install
It' Jekyll god dammit:
1. Clone this repository on your local,
1. [Install Jekyll](https://github.com/mojombo/jekyll/wiki/install),
1. Go at the root of the repository and run ```jekyll serve --watch```,
1. Go to http://localhost:4000,
1. [Great success! High five!](http://www.youtube.com/watch?v=wWWyJwHQ-4E)
## How to...
### Adding a new API call
You can add a new API call by simply adding a new post in the `_posts` folder. Jekyll by default forces you to specify a date in the file path: it makes us sad pandas too, but you'll have to stick to this format. You can use dates to control the order in which API calls are displayed in the interface.
Each API call can define a few values in its YAML header:
Variable | Mandatory | Default | Description
--- | --- | --- | ---
``title`` | Y | - | A short description of what that calls does.
``path`` | N | - | The URL for the API call, including potential parameters.
``type`` | N | - | Set it to `PUT`, `GET`, `POST`, `DELETE` or nothing (for parts of your documentation that do not relate to an actual API call).
A typical header:
```
---
path: '/stuff/:id'
title: 'Delete a thing'
type: 'DELETE'
layout: nil
---
```
We then describe the request and response (or whatever else you wish to talk about) in the body of our post. Check the placeholders present in the `_posts` folder to get an idea of what it can look like.
### Grouping calls
Adding a category to your YAML header will allows you to group methods in the navigation. It is particularly helpful as you start having a lot of methods and need to organize them. For example:
```
---
category: Stuff
path: '/stuff/:id'
title: 'Delete a thing'
type: 'DELETE'
layout: nil
---
```
### Edit the design
The default UI is mostly described through the `css/style.css` file and a couple short jQuery scripts in the `/_layouts/default.html` layout. Hack it to oblivion.

1
docs/_config.y0ml Normal file
View File

@ -0,0 +1 @@
theme: jekyll-theme-minimal

View File

@ -1,6 +0,0 @@
---
exclude: ['README.markdown', 'gitpod']
permalink: ':title'
pygments: true
safe: false
title: 'Zernit'

View File

@ -1,19 +0,0 @@
<h1>{{ site.title }}</h1>
<ul id='links'>
{% for post in site.posts %}
{% if post.category == null %}
<li><a href='#{{ post.url }}'>{{ post.title }}</a></li>
{% endif %}
{% endfor %}
{% for category in site.categories %}
<li><h2>{{ category | first }}</h2>
<ul>
{% for posts in category %}
{% for post in posts %}
<li class='{{ post.type }}'><a href='#{{ post.url }}'>{{ post.title }}</a></li>
{% endfor %}
{% endfor %}
</ul>
</li>
{% endfor %}
</ul>

View File

@ -1,17 +0,0 @@
<!DOCTYPE html>
<head>
<title>{{ site.title }}</title>
<meta charset='utf-8'/>
<meta name='description' content='Documentation website'/>
<meta name='viewport' content='width=device-width, initial-scale=1, maximum-scale=1'/>
<link href='http://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'/>
<link href='assets.css' rel='stylesheet' type='text/css'>
</head>
<body>
{{ content }}
<!--[if lt IE 9]><script src='http://html5shim.googlecode.com/svn/trunk/html5.js'></script><![endif]-->
<script src='assets.js' type='text/javascript'></script>
<script>require('boot');</script>
</body>
</html>

View File

@ -1,9 +0,0 @@
---
category: Maintainance
title: 'Review process'
layout: nil
---
FIXME-DOCS: preamble
1. Everything has to pass tests unless the merge request is not causing the test failure

View File

@ -1,30 +0,0 @@
---
category: About
title: 'Four freedoms compliance'
layout: nil
---
Disclaimer: This is still part of ongoing effort to make this repository FSF approved while allow for sustainable business plan assuming this repository being expected to be used for commercial use.
Content provided in this post is subject to change and contributions are welcommed where we are welcomming challenges about these decisions and requests to adapt license for your workflow.
Based on feedback from majority of Free Software Foundation members based on discussion in https://forum.members.fsf.org/t/help-me-with-gpl-3-inspired-license-designed-for-commercial-use-and-to-avoid-segmentation/1953/59 this repository does not comply with four freedoms as follows where we are doing our best on ongoing effort to make this project compliant while allowing sustainable business plan:
- The freedom to run the program as you wish, for any purpose (freedom 0).
Usage of software is restricted by the license to direct the workflow in original repository since segmentation as example provided with ripple project on https://github.com/osuripple/lets/pull/5 to avoid segmentation alike https://github.com/light-ripple and many others that based on our point of view only sabotages the original project.
- The freedom to study how the program works, and change it so it does your computing as you wish (freedom 1). Access to the source code is a precondition for this.
We believe that this is not restricted since the project is open-source and you are allowed to perform any changes where the features that can be merged in original project are required to be merged where we will grant you write access based on proved competence to maintian said part with planned option to get paid for this service.
If the fork does not have a feature that could be merged in the project itself then we allow this fork.
- The freedom to redistribute copies so you can help others (freedom 2).
This is restricted since spread of malware of outdated versions of this project is a concern.
License is planned to contain conditions to avoid this unwanted behavior.
- The freedom to distribute copies of your modified versions to others (freedom 3). By doing this you can give the whole community a chance to benefit from your changes. Access to the source code is a precondition for this.
This is not restricted for standalone forks as long as said repositories are not containing features that project finds usefull in which scenario we will provide an official way for said feature to be merged in our upstream without restricting your right to have access in said code assuming that you are competent enough to perform such maintainance. If not we do our best to teach you.

View File

@ -1,639 +0,0 @@
/*! normalize.css v2.1.0 | MIT License | git.io/normalize */
/* ==========================================================================
HTML5 display definitions
========================================================================== */
/**
* Correct `block` display not defined in IE 8/9.
*/
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
nav,
section,
summary {
display: block;
}
/**
* Correct `inline-block` display not defined in IE 8/9.
*/
audio,
canvas,
video {
display: inline-block;
}
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0;
}
/**
* Address styling not present in IE 8/9.
*/
[hidden] {
display: none;
}
/* ==========================================================================
Base
========================================================================== */
/**
* 1. Set default font family to sans-serif.
* 2. Prevent iOS text size adjust after orientation change, without disabling
* user zoom.
*/
html {
font-family: sans-serif; /* 1 */
-webkit-text-size-adjust: 100%; /* 2 */
-ms-text-size-adjust: 100%; /* 2 */
}
/**
* Remove default margin.
*/
body {
margin: 0;
}
/* ==========================================================================
Links
========================================================================== */
/**
* Address `outline` inconsistency between Chrome and other browsers.
*/
a:focus {
outline: thin dotted;
}
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0;
}
/* ==========================================================================
Typography
========================================================================== */
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari 5, and Chrome.
*/
h1 {
font-size: 2em;
margin: 0.67em 0;
}
/**
* Address styling not present in IE 8/9, Safari 5, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted;
}
/**
* Address style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
*/
b,
strong {
font-weight: bold;
}
/**
* Address styling not present in Safari 5 and Chrome.
*/
dfn {
font-style: italic;
}
/**
* Address differences between Firefox and other browsers.
*/
hr {
-moz-box-sizing: content-box;
box-sizing: content-box;
height: 0;
}
/**
* Address styling not present in IE 8/9.
*/
mark {
background: #ff0;
color: #000;
}
/**
* Correct font family set oddly in Safari 5 and Chrome.
*/
code,
kbd,
pre,
samp {
font-family: monospace, serif;
font-size: 1em;
}
/**
* Improve readability of pre-formatted text in all browsers.
*/
pre {
white-space: pre-wrap;
}
/**
* Set consistent quote types.
*/
q {
quotes: "\201C" "\201D" "\2018" "\2019";
}
/**
* Address inconsistent and variable font size in all browsers.
*/
small {
font-size: 80%;
}
/**
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sup {
top: -0.5em;
}
sub {
bottom: -0.25em;
}
/* ==========================================================================
Embedded content
========================================================================== */
/**
* Remove border when inside `a` element in IE 8/9.
*/
img {
border: 0;
}
/**
* Correct overflow displayed oddly in IE 9.
*/
svg:not(:root) {
overflow: hidden;
}
/* ==========================================================================
Figures
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari 5.
*/
figure {
margin: 0;
}
/* ==========================================================================
Forms
========================================================================== */
/**
* Define consistent border, margin, and padding.
*/
fieldset {
border: 1px solid #c0c0c0;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em;
}
/**
* 1. Correct `color` not being inherited in IE 8/9.
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
*/
legend {
border: 0; /* 1 */
padding: 0; /* 2 */
}
/**
* 1. Correct font family not being inherited in all browsers.
* 2. Correct font size not being inherited in all browsers.
* 3. Address margins set differently in Firefox 4+, Safari 5, and Chrome.
*/
button,
input,
select,
textarea {
font-family: inherit; /* 1 */
font-size: 100%; /* 2 */
margin: 0; /* 3 */
}
/**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
* the UA stylesheet.
*/
button,
input {
line-height: normal;
}
/**
* Address inconsistent `text-transform` inheritance for `button` and `select`.
* All other form control elements do not inherit `text-transform` values.
* Correct `button` style inheritance in Chrome, Safari 5+, and IE 8+.
* Correct `select` style inheritance in Firefox 4+ and Opera.
*/
button,
select {
text-transform: none;
}
/**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/
button,
html input[type="button"], /* 1 */
input[type="reset"],
input[type="submit"] {
-webkit-appearance: button; /* 2 */
cursor: pointer; /* 3 */
}
/**
* Re-set default cursor for disabled elements.
*/
button[disabled],
html input[disabled] {
cursor: default;
}
/**
* 1. Address box sizing set to `content-box` in IE 8/9.
* 2. Remove excess padding in IE 8/9.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
}
/**
* 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield; /* 1 */
-moz-box-sizing: content-box;
-webkit-box-sizing: content-box; /* 2 */
box-sizing: content-box;
}
/**
* Remove inner padding and search cancel button in Safari 5 and Chrome
* on OS X.
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* Remove inner padding and border in Firefox 4+.
*/
button::-moz-focus-inner,
input::-moz-focus-inner {
border: 0;
padding: 0;
}
/**
* 1. Remove default vertical scrollbar in IE 8/9.
* 2. Improve readability and alignment in all browsers.
*/
textarea {
overflow: auto; /* 1 */
vertical-align: top; /* 2 */
}
/* ==========================================================================
Tables
========================================================================== */
/**
* Remove most spacing between table cells.
*/
table {
border-collapse: collapse;
border-spacing: 0;
}
/* GENERAL */
html,
body {
height: 100%;
}
body {
background: #fff;
}
body,
input,
textarea {
color: #191919;
font: 14px/140% 'Open Sans', Arial, sans-serif;
}
a {
color: #119bdf;
text-decoration: none;
}
a:hover {
color: #29aeef;
text-decoration: underline;
}
h1,
h2,
h3,
h4,
p,
ul,
code {
margin: 0 0 20px;
}
code {
font-family: 'Monaco', monospace, sans-serif;
}
/* SIDEBAR */
#sidebar {
background: #191919;
color: #fff;
float: left;
height: 100%;
overflow: auto;
position: fixed;
top: 0;
width: 240px;
}
#sidebar h1 {
background: #111;
font-size: 14px;
margin: 0;
padding: 20px;
text-transform: uppercase;
}
#sidebar h2 {
color: #888;
font-size: 14px;
margin: 0;
}
#sidebar ul {
list-style: none;
margin: 0;
padding: 0;
}
#sidebar ul#links {
padding: 20px;
}
#sidebar ul ul {
padding-left: 20px;
}
#sidebar ul li a {
color: #fff;
display: block;
padding: 0 0 15px;
}
#sidebar ul li a:active,
#sidebar ul li a.active {
text-decoration: underline;
}
#sidebar input {
background: #111;
border: 0;
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
box-shadow: inset 0 0 5px rgba(0, 0, 0, 0.2);
-moz-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.2);
-webkit-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.2);
color: #ddd;
margin-bottom: 20px;
padding: 5px 10px;
}
#sidebar input:active,
#sidebar input:focus {
border-color: #ccc;
box-shadow: inset 0 0 5px rgba(0, 0, 0, 0.1);
-moz-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.1);
-webkit-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.1);
outline: none;
}
/* References */
#content {
padding: 20px;
padding-left: 260px;
max-width: 700px;
}
#content .control {
cursor: pointer;
font-size: 12px;
margin-left: 15px;
}
#content article {
clear: both;
margin: 15px 0;
}
#content article > a {
background: #333;
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
cursor: pointer;
display: block;
padding: 15px;
}
#content article > a:hover {
background: #222;
text-decoration: none;
}
#content a h2 {
color: #fff;
font-size: 18px;
font-weight: normal;
margin: 0;
}
#content a h2 code {
float: right;
font-size: 14px;
}
#content a h2 code b {
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
color: #fff;
font-weight: normal;
padding: 3px 6px;
}
/* Default */
#content article {
border-color: #e2e7ea;
}
#content article a h2 code {
color: #657e8b;
}
#content article a h2 code b {
background: #657e8b;
text-transform: uppercase;
}
/* GET */
#content article.GET a h2 code {
color: #119bdf;
}
#content article.GET a h2 code b {
background: #119bdf;
}
/* POST */
#content article.POST a h2 code {
color: #52ce0e;
}
#content article.POST a h2 code b {
background: #52ce0e;
}
/* PUT */
#content article.PUT a h2 code {
color: #e08f10;
}
#content article.PUT a h2 code b {
background: #e08f10;
}
/* DELETE */
#content article.DELETE a h2 code {
color: #e02a10;
}
#content article.DELETE a h2 code b {
background: #e02a10;
}
/* Reference's body */
#content h3 {
}
#content .body {
border-top: 1px solid #eef1f2;
display: block;
padding: 15px 15px 0;
}
#content .body code {
border: 1px solid #e2e7ea;
background: #eef1f2;
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
color: #546974;
padding: 0 1px;
}
#content .body p > code {
display: block;
padding: 15px;
white-space: pre;
}

File diff suppressed because it is too large Load Diff

View File

@ -1,7 +0,0 @@
{
"name": "carte",
"description": "Simple API reference",
"version": "0.0.1",
"local": ["boot"],
"paths": ["lib"]
}

View File

@ -1,7 +0,0 @@
FROM gitpod/workspace-full-vnc
USER root
## JEKYLL ##
RUN apt update && apt install -y ruby ruby-dev firefox

View File

@ -1,18 +0,0 @@
---
layout: default
---
<nav id='sidebar'>
{% include nav.html %}
</nav>
<section id='content'>
{% for post in site.posts %}
<article class='{{ post.type }}'>
<a name='{{ post.url }}' href='#{{ post.url }}'><h2>{% if post.type %}<code><b>{{ post.type }}</b> {{ post.path }}</code> {% endif %}{{ post.title }}</h2></a>
<section class='body'>
{{ post.content }}
</section>
</article>
{% endfor %}
</section>

1
docs/index.md Normal file
View File

@ -0,0 +1 @@
WIP

View File

@ -1,11 +0,0 @@
{
"name": "boot",
"description": "Main app boot component",
"dependencies": {
"necolas/normalize.css": "*",
"component/jquery": "*"
},
"local": ["filter"],
"scripts": ["index.js"],
"styles": ["style.css"]
}

View File

@ -1,49 +0,0 @@
var $ = require('jquery'),
Filter = require('filter');
// Collapsible articles
$('article').each(function () {
var that = $(this);
var header = that.children('a');
var body = that.children('.body');
body.hide();
header.toggle(
function () { body.slideDown('fast'); that.addClass('active'); },
function () { body.slideUp('fast'); that.removeClass('active'); }
);
});
var anchor = window.location.hash.substring(1);
if (anchor) $('article a[name=' + anchor + ']').trigger('click');
// Expanding the article on link click and scrolling down to it
$('#sidebar a').each(function () {
var that = $(this);
var id = that.attr('href').substring(1);
that.click(function (e) {
var header = $('article a[name="'+ id +'"]')
if (!header.parent().hasClass('active')) header.trigger('click');
$('html, body').animate({ scrollTop: header.offset().top }, 'fast');
});
// If we find a link in the body with similar anchor, add the same behavior
$('.body a[href=#'+ id +']').click(function (e) {
$('#sidebar a[href=#'+ id +']').trigger('click');
});
});
// Hide all/Show all links
var show = $('<a class=\'control show\'>Show all</a>');
show.click(function () {
$('#content article:not(".active") > a').trigger('click');
});
$('#content').prepend(show);
var hide = $('<a class=\'control hide\'>Hide all</a>');
hide.click(function () {
$('#content article.active > a').trigger('click');
});
$('#content').prepend(hide);
// Making our navigation sticky
new Filter($('#sidebar > ul'));

View File

@ -1,240 +0,0 @@
/* GENERAL */
html,
body {
height: 100%;
}
body {
background: #fff;
}
body,
input,
textarea {
color: #191919;
font: 14px/140% 'Open Sans', Arial, sans-serif;
}
a {
color: #119bdf;
text-decoration: none;
}
a:hover {
color: #29aeef;
text-decoration: underline;
}
h1,
h2,
h3,
h4,
p,
ul,
code {
margin: 0 0 20px;
}
code {
font-family: 'Monaco', monospace, sans-serif;
}
/* SIDEBAR */
#sidebar {
background: #191919;
color: #fff;
float: left;
height: 100%;
overflow: auto;
position: fixed;
top: 0;
width: 240px;
}
#sidebar h1 {
background: #111;
font-size: 14px;
margin: 0;
padding: 20px;
text-transform: uppercase;
}
#sidebar h2 {
color: #888;
font-size: 14px;
margin: 0;
}
#sidebar ul {
list-style: none;
margin: 0;
padding: 0;
}
#sidebar ul#links {
padding: 20px;
}
#sidebar ul ul {
padding-left: 20px;
}
#sidebar ul li a {
color: #fff;
display: block;
padding: 0 0 15px;
}
#sidebar ul li a:active,
#sidebar ul li a.active {
text-decoration: underline;
}
#sidebar input {
background: #111;
border: 0;
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
box-shadow: inset 0 0 5px rgba(0, 0, 0, 0.2);
-moz-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.2);
-webkit-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.2);
color: #ddd;
margin-bottom: 20px;
padding: 5px 10px;
}
#sidebar input:active,
#sidebar input:focus {
border-color: #ccc;
box-shadow: inset 0 0 5px rgba(0, 0, 0, 0.1);
-moz-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.1);
-webkit-box-shadow: inset 0 1px 5px rgba(0, 0, 0, 0.1);
outline: none;
}
/* References */
#content {
padding: 20px;
padding-left: 260px;
max-width: 700px;
}
#content .control {
cursor: pointer;
font-size: 12px;
margin-left: 15px;
}
#content article {
clear: both;
margin: 15px 0;
}
#content article > a {
background: #333;
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
cursor: pointer;
display: block;
padding: 15px;
}
#content article > a:hover {
background: #222;
text-decoration: none;
}
#content a h2 {
color: #fff;
font-size: 18px;
font-weight: normal;
margin: 0;
}
#content a h2 code {
float: right;
font-size: 14px;
}
#content a h2 code b {
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
color: #fff;
font-weight: normal;
padding: 3px 6px;
}
/* Default */
#content article {
border-color: #e2e7ea;
}
#content article a h2 code {
color: #657e8b;
}
#content article a h2 code b {
background: #657e8b;
text-transform: uppercase;
}
/* GET */
#content article.GET a h2 code {
color: #119bdf;
}
#content article.GET a h2 code b {
background: #119bdf;
}
/* POST */
#content article.POST a h2 code {
color: #52ce0e;
}
#content article.POST a h2 code b {
background: #52ce0e;
}
/* PUT */
#content article.PUT a h2 code {
color: #e08f10;
}
#content article.PUT a h2 code b {
background: #e08f10;
}
/* DELETE */
#content article.DELETE a h2 code {
color: #e02a10;
}
#content article.DELETE a h2 code b {
background: #e02a10;
}
/* Reference's body */
#content h3 {
}
#content .body {
border-top: 1px solid #eef1f2;
display: block;
padding: 15px 15px 0;
}
#content .body code {
border: 1px solid #e2e7ea;
background: #eef1f2;
border-radius: 2px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
color: #546974;
padding: 0 1px;
}
#content .body p > code {
display: block;
padding: 15px;
white-space: pre;
}

View File

@ -1,8 +0,0 @@
{
"name": "filter",
"description": "Makes lists of links filterable.",
"dependencies": {
"component/jquery": "*"
},
"scripts": ["index.js"]
}

View File

@ -1,48 +0,0 @@
// Dependencies
var $ = require('jquery');
// Expose `Filter`.
module.exports = Filter;
// Case-insensitive contains()
$.expr[':'].Contains = function(a,i,m){
return (a.textContent || a.innerText || '').toUpperCase().indexOf(m[3].toUpperCase())>=0;
};
/**
* Initialize a filterable list.
*/
function Filter(list) {
this.el = list;
// Filter input
var form = $('<form>').attr({ 'action':'#' });
var input = $('<input>').attr({ 'type':'text', 'placeholder':'Filter by keyword' });
$(form).append(input).prependTo(this.el);
// Filter function
var self = this;
$(input).change(function () {
var filter = $(this).val();
if(filter) {
$(self.el).find('a:not(:Contains(' + filter + '))').parent().hide();
$(self.el).find('a:Contains(' + filter + ')').parent().show();
} else {
$(self.el).find('li').show();
}
// Hide titles when group is empty
$(self.el).find('ul').each(function () {
if (!$(this).find('li:visible').length) {
$(this).prev('h2').hide();
} else {
$(this).prev('h2').show();
}
});
return false;
})
.keyup( function () { $(this).change(); });
return this;
}

View File

@ -1,2 +0,0 @@
User-agent: *
Disallow: /images/

View File

@ -1,12 +0,0 @@
SUCCESS: test!
SUCCESS: test!
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil
SUCCESS: nil

View File

@ -1,34 +0,0 @@
FROM debian:latest
# To avoid bricked workspaces (https://github.com/gitpod-io/gitpod/issues/1171)
ENV DEBIAN_FRONTEND=noninteractive
USER root
ENV LANG=en_US.UTF-8
ENV LC_ALL=C
# Add 'gitpod' user
RUN useradd \
--uid 33333 \
--create-home --home-dir /home/gitpod \
--shell /bin/bash \
--password gitpod \
gitpod || exit 1
# Install dependencies
RUN apt-get update \
&& apt-get install -y rustc sudo cargo pkg-config \
&& : "Install hadolint if not available in downstream" \
&& if ! apt-cache search hadolint | grep -qP "^hadolint -.*"; then { if ! command -v wget >/dev/null; then apt-get install -y wget; fi ;} && wget https://github.com/hadolint/hadolint/releases/download/v1.17.5/hadolint-Linux-x86_64 -O /usr/bin/hadolint && { [ ! -x /usr/bin/hadolint ] && chmod +x /usr/bin/hadolint ;}; elif apt-cache search hadolint | grep -qP "^hadolint -.*"; then apt-get install -y hadolint; fi \
&& curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh \
&& apt-get autoremove -y \
&& rm -rf /var/lib/apt/lists/*
# Add custom functions
RUN if ! grep -qF 'ix()' /etc/bash.bashrc; then printf '%s\n' \
'# Custom' \
"ix() { curl -F 'f:1=<-' ix.io 2>/dev/null ;}" \
>> /etc/bash.bashrc; fi
USER gitpod

View File

@ -1,15 +0,0 @@
FROM scratch
# Blocked by https://github.com/gitpod-io/gitpod/issues/39
COPY gitpod/scripts/root-access.sh /usr/bin/root-access
RUN true "7a8fhs1g" \
&& chmod +x /usr/bin/root-access \
&& /usr/bin/root-access \
&& rm /usr/bin/root-access
# Blocked by https://github.com/gitpod-io/gitpod/issues/1265
COPY gitpod/scripts/vm-support.sh /usr/bin/vm-support
RUN true "dg798sda7h" \
&& chmod +x /usr/bin/vm-support \
&& /usr/bin/vm-support \
&& rm /usr/bin/vm-support

View File

@ -1,57 +1,19 @@
FROM gitpod/workspace-full-vnc:latest
FROM gitpod/workspace-full
# Blocked by https://github.com/gitpod-io/gitpod/issues/39
COPY gitpod/scripts/root-access.sh /usr/bin/root-access
RUN true "7a8fhs1g" \
&& chmod +x /usr/bin/root-access \
&& /usr/bin/root-access \
&& rm /usr/bin/root-access
# Blocked by https://github.com/gitpod-io/gitpod/issues/1265
COPY gitpod/scripts/vm-support.sh /usr/bin/vm-support
RUN true "dg798sda7h" \
&& chmod +x /usr/bin/vm-support \
&& /usr/bin/vm-support \
&& rm /usr/bin/vm-support
# FIXME: Add hadolint executable
# To avoid bricked workspaces (https://github.com/gitpod-io/gitpod/issues/1171)
ARG DEBIAN_FRONTEND=noninteractive
# APT management (https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#apt-get)
RUN curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - \
&& add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable" \
&& apt-get update \
&& apt-get upgrade -y \
&& curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - \
&& apt dist-upgrade -y \
&& : "Install hadolint if not available in downstream" \
&& if ! apt-cache search hadolint | grep -qP "^hadolint -.*"; then { if command -v wget >/dev/null; then apt install -y wget; fi ;} && wget https://github.com/hadolint/hadolint/releases/download/v1.17.5/hadolint-Linux-x86_64 -O /usr/bin/hadolint && { [ ! -x hadolint ] && chmod +x /usr/bin/hadolint ;}; elif apt-cache search hadolint | grep -qP "^hadolint -.*"; then apt install -y hadolint; fi \
&& apt-get install -y clang valgrind shellcheck docker-ce docker-ce-cli containerd.io firefox tree xclip umbrello gnuplot fish zsh dia \
&& rm -rf /var/lib/apt/lists/* \
&& apt autoremove -y
## User config
# USER gitpod
# RUN curl -L https://get.oh-my.fish | fish \
# && sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" \
# && git clone --depth=1 https://github.com/Bash-it/bash-it.git /usr/src/bash-it \
# && /usr/src/bash-it/install.sh
### VLANG ###
USER root
ENV VLANG_VERSION="0.1.24"
COPY gitpod/vlang_init4.sh /usr/bin/vlang_init
RUN chmod +x /usr/bin/vlang_init
RUN vlang_init || exit 1
# Add custom functions
RUN if ! grep -qF 'ix()' /etc/bash.bashrc; then printf '%s\n' \
'# Custom' \
"ix() { curl -F 'f:1=<-' ix.io 2>/dev/null ;}" \
"xcopy() { xclip -se C ;}" \
>> /etc/bash.bashrc; fi
# Update apt repositories
RUN apt-get update
# Upgrade the image
RUN apt upgrade -y
RUN apt dist-upgrade -y
# Install linting dependencies
RUN apt install -y shellcheck
# Remove apt sources to clean up space
RUN rm -rf /var/lib/apt/lists/*
# Clean-up unneeded packages
RUN apt autoremove -y

View File

@ -1,43 +0,0 @@
#!/bin/sh
# Created by Jacob Hrbek <kreyren@rixotstudio.cz> under GPLv3 <https://www.gnu.org/licenses/gpl-3.0.en.html> in 19/05/2020 16:28
###! Terminate gitpod if the blocking root access bug has not been resolved yet
# FIXME: Quick-script
set -e
# FIXME: Rushed
die() {
printf 'FATAL: %s\n' "$2"
exit "$1"
}
# FIXME: Sanitize
if ! command -v curl 1>/dev/null; then
apt-get update
apt-get install curl -y
elif command -v curl 1>/dev/null; then
true
else
die 255 "processing curl"
fi
bugStatus="$(curl https://api.github.com/repos/gitpod-io/gitpod/issues/39 2>/dev/null | grep -o state.* || true)"
case "$bugStatus" in
"state\": \"open\",")
printf '\033[31m\033[1mBLOCKED:\033[0m %s\n' "Gitpod does not provide a root access which is mandatory for this repository, see it's tracking in https://github.com/gitpod-io/gitpod/issues/39"
if [ "$GITPOD_IGNORE_BLOCKERS" != 1 ]; then
exit 1
else
true
fi
;;
"state\": \"closed\",")
true
;;
*)
printf '\033[31m\033[1mBUG:\033[0m %s\n' "GitHub API returned an unknown state '$bugStatus' of bug https://github.com/gitpod-io/gitpod/issues/39"
exit 1
esac

View File

@ -1,43 +0,0 @@
#!/bin/sh
# Created by Jacob Hrbek <kreyren@rixotstudio.cz> under GPLv3 <https://www.gnu.org/licenses/gpl-3.0.en.html> in 19/05/2020 16:28
###! Terminate gitpod if the blocking root access bug has not been resolved yet
# FIXME: Quick-script
set -e
# FIXME: Rushed
die() {
printf 'FATAL: %s\n' "$2"
exit "$1"
}
# FIXME: Sanitize
if ! command -v curl 1>/dev/null; then
apt-get update
apt-get install curl -y
elif command -v curl 1>/dev/null; then
true
else
die 255 "processing curl"
fi
bugStatus="$(curl https://api.github.com/repos/gitpod-io/gitpod/issues/1265 2>/dev/null | grep -o state.* || true)"
case "$bugStatus" in
"state\": \"open\",")
die 1 "Gitpod does not provide a VM support which blocks cross-platform development, see tracking on https://github.com/gitpod-io/gitpod/issues/1265"
if [ "$GITPOD_IGNORE_BLOCKERS" != 1 ]; then
exit 1
else
true
fi
;;
"state\": \"closed\",")
true
;;
*)
printf '\033[31m\033[1mBUG:\033[0m %s\n' "GitHub API returned an unknown state '$bugStatus' of bug https://github.com/gitpod-io/gitpod/issues/1265"
exit 1
esac

View File

@ -1,158 +0,0 @@
#!/bin/sh
# Created by Jacob Hrbek <kreyren@rixotstudio.cz> under license GPL-3 (https://www.gnu.org/licenses/gpl-3.0.en.html)
# Based in part on https://github.com/JesterOrNot/Gitpod-V which is created by Sean Hellum as unlicense
: "
Initialization script made for gitpod to install vlang backend in gitpod
This script is developed to be POSIX-compatible
Use environment variable '$DEBUG' to output verbose info
CONFIGURATION
- $VLANG_SOURCE = Path used for extraction and keeping of vlang source files
- $VLANG_VERSION = Expected vlang version (value 'latest' is supported through GitHub API)
- $VLANG_GROUP = Group used for those that are expected to have access in vlang
- $CACHEDIR = Path for cache directory, based on FSH3.0 (270120) this should be '$HOME/.cache'
- $VLANG_EXE = Path to which we will extract executable for vlang
"
# Configuration
[ -z "$VLANG_SOURCE" ] && VLANG_SOURCE="/opt/vlang"
[ -z "$VLANG_VERSION" ] && VLANG_VERSION="0.1.24"
[ -z "$VLANG_GROUP" ] && VLANG_GROUP="vlang"
[ -z "$CACHEDIR" ] && CACHEDIR="$HOME/.cache"
[ -z "$VLANG_EXE" ] && VLANG_EXE="/usr/bin/v"
# Simplified die for assertion
die() {
[ -z "$DIE_PREFIX" ] && DIE_PREFIX="FATAL:"
printf "$DIE_PREFIX %s\\n" "$2"
unset VLANG_SOURCE VLANG_VERSION DIE_PREFIX CACHEDIR VLANG_EXE
exit "$1"
}
edebug() {
[ -z "$DEBUG_PREFIX" ] && DEBUG_PREFIX="DEBUG:"
[ -n "$DEBUG" ] && printf "$DEBUG_PREFIX %s\\n" "$1"
}
# checkroot
if [ "$(id -u)" != "0" ]; then
die 3 "Insufficient permission UID '$(id -u)' used for vlang initialization"
elif [ "$(id -u)" = "0" ]; then
edebug "Script has been executed from expected used with UID '$(id -u)'"
else
die 256 "Unexpected happend while checking root"
fi
# Define latest version
case "$VLANG_VERSION" in
[0-9].[0-9].[0-9]|[0-9][0-9].[0-9].[0-9]|[0-9][0-9].[0-9][0-9].[0-9]|[0-9][0-9].[0-9][0-9].[0-9][0-9]|[0-9].[0-9][0-9].[0-9]|[0-9].[0-9].[0-9][0-9]) true ;;
latest)
VLANG_VERSION="$(curl https://api.github.com/repos/vlang/v/releases/latest 2>/dev/null | grep tag_name | sed '/^[[:blank:]]*"tag_name":[[:blank:]]*"\([^"]*\)",[[:blank:]]*$/!d; s//\1/; q' || die 4 "Unable to get latest vlang version for GitHub API")" ;;
*) die 2 "Unsupported vlang version '$VLANG_VERSION' has been parsed in vlang_init script"
esac
# Create cachedir
if [ ! -d "$CACHEDIR" ]; then
mkdir "$CACHEDIR" || die 1 "Unable to make a new directory in '$HOME/.cache' used for caching"
edebug "Created a new directory in '$CACHEDIR' used for caching"
elif [ -d "$CACHEDIR" ]; then
edebug "Directory '$CACHEDIR' already exits, skipping creation"
else
die 256 "Unexpected happend while creating chachedir, bug?"
fi
# Fetch
if [ ! -f "$CACHEDIR/vlang-$VLANG_VERSION.zip" ]; then
wget "https://github.com/vlang/v/releases/download/$VLANG_VERSION/v_linux.zip" -O "$CACHEDIR/vlang-$VLANG_VERSION.zip" || die 1 "Unable to fetch vlang tarball"
edebug "Vlang source tarball has been exported in '$CACHEDIR/vlang-$VLANG_VERSION.zip'"
elif [ -f "$CACHEDIR/vlang-$VLANG_VERSION.zip" ]; then
edebug "File '$CACHEDIR/vlang-$VLANG_VERSION.zip' already exists, skipping fetch"
else
die 256 "Unexpected happend while fetching vlang source tarball in '$CACHEDIR/vlang-$VLANG_VERSION'"
fi
# Create a new directory used for source files
if [ ! -d "$VLANG_SOURCE" ]; then
mkdir "$VLANG_SOURCE" || die 1 "Unable to create a new directory for source extraction of vlang"
edebug "Created a new directory in '$VLANG_SOURCE' used for vlang source files"
elif [ -d "$VLANG_SOURCE" ]; then
edebug "Directory in '$VLANG_SOURCE' is already present, skipping creation"
else
die 256 "Unexpected happend while creating a new directory in '$VLANG_SOURCE'"
fi
# Extract
if [ ! -f "$VLANG_SOURCE/Makefile" ]; then
unzip "$CACHEDIR/vlang-$VLANG_VERSION.zip" -d "$VLANG_SOURCE" || die 1 "Unable to extract vlang source in '$VLANG_SOURCE' directory"
edebug "vlang source files has been extracted in '$VLANG_SOURCE'"
elif [ -f "$VLANG_SOURCE/Makefile" ]; then
edebug "vlang source files are already extracted, skipping extract"
else
die 256 "Unexpected happend while extracting vlang source files"
fi
# Compile
if [ ! -f "$VLANG_SOURCE/v" ]; then
make -C "$VLANG_SOURCE" || die 1 "This system is unable to compile vlang"
edebug "vlang has been sucessfully compiled"
elif [ -f "$VLANG_SOURCE/v" ]; then
edebug "vlang is already compiled, skipping compilation"
else
die 256 "Unexpected happend while compiling vlang source files"
fi
# Export executable
if [ ! -h "$VLANG_EXE" ] && [ ! -f "$VLANG_EXE" ]; then
ln -sf "$VLANG_SOURCE/v" "$VLANG_EXE" || die 1 "Unable to symlink vlang executable in '$VLANG_EXE'"
edebug "Vlang executable has been sucessfully symlinked"
elif [ -f "$VLANG_EXE" ]; then
die 1 "Pathname '$VLANG_EXE' is a file where symlink to compiled vlang compiler is expected"
elif [ -h "$VLANG_EXE" ]; then
edebug "Vlang executable is already symlinked, skipping.."
fi
# Create a new user-group for vlang users
if ! grep -qF vlang /etc/passwd 2>/dev/null; then
groupadd vlang || die 1 "Unable to make a new user-group 'vlang'"
edebug "Created a new user-group 'vlang'"
elif grep -qF vlang /etc/passwd 2>/dev/null; then
edebug "User-group 'vlang' already exists, skipping creation"
else
die 256 "Unexpected happend while creating new user-group 'vlang'"
fi
# Transfer ownership of VLANG_SOURCE to vlang user-group
if [ "$(stat -c '%G' "$VLANG_SOURCE")" != vlang ]; then
chown -R root:vlang "$VLANG_SOURCE" || die 1 "Unable to transfer ownership of '$VLANG_SOURCE' directory to vlang user-group"
edebug "Permission to '$VLANG_SOURCE' directory has been transfered to vlang user-group"
elif [ "$(stat -c '%G' "$VLANG_SOURCE")" = vlang ]; then
edebug "Directory '$VLANG_SOURCE' is already owned by 'vlang' user-group"
else
die 256 "Unexpected happend while transfering '$VLANG_SOURCE' directory to 'vlang' user-group"
fi
# Add gitpod user in vlang group
if ! groups | grep -qF "$VLANG_GROUP"; then
usermod -a -G "$VLANG_GROUP" gitpod || die 1 "Unable to transfer user 'gitpod' in user-group '$VLANG_GROUP'"
chmod -R 0775 "$VLANG_SOURCE" || die 1 "Unable to set ownership to '$VLANG_SOURCE"
edebug "User 'gitpod' has been added in user-group '$VLANG_GROUP'"
elif groups | grep -qF $VLANG_GROUP; then
edebug "User 'gitpod' is already in user-group '$VLANG_GROUP'"
else
die 256 "Unexpected happend while adding user 'gitpod' in user-group '$VLANG_GROUP'"
fi
# Selfcheck
# FIXME: Fix selfcheck
# su gitpod -c "$VLANG_EXE" help 1>/dev/null
# case "$?" in
# 0) printf 'INFO: %s\n' "builtin vlang selfcheck passed" ;;
# *) die "$?" "builtin vlang selfcheck failed"
# esac
# Master unset
unset VLANG_SOURCE VLANG_VERSION DIE_PREFIX CACHEDIR VLANG_EXE

View File

@ -1,191 +0,0 @@
#!/usr/bin/zernit sh
# Created by Jacob Hrbek <kreyren@rixotstudio,cz> under all rights reserved in 11/08/2020 01:02:33 CEST
# shellcheck shell=sh # Written to be POSIX compatible
###! Script designed to generate the white paper for this project in supported language
###! The whitepaper should be done to be understandable by the general public so avoid over-complication where possible.
[ -n "$whitepaperPath" ] || whitepaperPath="README.md"
# FIXME: Implement logic to deduce this
UPSTREAM_NAME="Zernit"
sectionNumber=0
# Exit on anything unexpected to capture code quality issues
set -x
# Wipe the current whipaper
"$PRINTF" '%s\n' "" > "$whitepaperPath"
# Title
case "$LANG" in
*)
"$CAT" <<-EOF >> "$whitepaperPath"
<h1 align="center">
<a href=$UPSTREAM_REPOSITORY>$PROJECT_NAME</a>
</h1>
EOF
esac
# Preamble
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
$PROJECT_NAME is a system-manager designed to make devices capable of running our written logic painless and efficient while maintaining highest possible code quality standard and platform compatibility.
This whitepaper is not legally bindable and is provided to be used as a reference for the software development and comunity management.
If you find a conflicting part in the source code, then file a new tracking in $UPSTREAM_REPOSITORY and we will process it with relevant priority to ensure that these conditions are met as soon as possible or brainstorm it for this whitepaper to be updated.
Contributions to this whitepaper and suggestions are appreciated to influece the relevant software development.
EOF
esac
# Terminology
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
## $(( sectionNumber + 1 )). Terminology
Software Users (SU) -- Parties that are using this software or are in other way affiliated with it or it's development
EOF
esac
# Ethicality
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
## $(( sectionNumber + 1 )). Project ethiques
FIXME-DOCS
EOF
esac
# Privacy
# FIXME: Add logic for the sub number
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
### $sectionNumber.1 Privacy
This project is designed to provide the absolute anonimity without compromise for it's SU unless relevant juristiction forces it to require informations of relevant parties in the area where said juristiction has the rightful authority to enforce these information processing that would otherwise make the usage of this software illegal in that area.
Data of SU should never be processed without an explicit permission that has to be opted-in and NEVER set by default at the cost of software malfunction (that should be sanitized to avoid fatal failure) where SU should never be prevented from using this software just because they don't want to provide their personal information.
Functions that explicitely require personal information should fail safely if said information is not provided or use a default value allowing the SU to blend into a crowd of anonymous users.
From experience with Enoch-based distributions alike Gentoo Linux as explained on hyperlink https://wiki.gentoo.org/wiki/User:MGorny/GCO_real_name_requirement it's required to provide an indentification to be allowed to submit changes to the source code.
This should never be limited on this project where possible and SU should have the option to submit their contribution under project's name (with their nickname if desired) if they don't want to or can't affort sharing this kind of information assuming that the contribution doesn't break the legal cleanroom and does not have a copyright which would make it impossible to be used in judistical areas that honors copyright law.
EOF
esac
# Freedom
# FIXME: Add logic for the sub number
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
### $sectionNumber.1 Freedom of relevant parties
This project is designed to give it's SU the full freedom of doing whatever they want with the software and most importantly with it's source code as long as it doesn't have a negative impact on the business plan with some flexibility from the Software Authorities.
This solution is not ideal, but it's the best that we currently have, proposals for a better solution are appreciated.
The license should contain 'Four Freedom Compilance' that should be maintained over time to ensure that the license complies with four essential freedoms of Free Software defined by Free Software Foundation as explained in https://en.wikipedia.org/wiki/The_Free_Software_Definition#The_Four_Essential_Freedoms_of_Free_Software
It's important to mension that this project can be abused for an illegal activity as a result of provided freedom above that the project has legal obligation to enforce per local juristiction of the user assuming that the user chosed to provide it's locality where these laws applies. Thus users that chosed to not provide their location should be warned about this risk as they can be legally prosecuted by the relevant juristiction for which zernit is not responsible.
EOF
esac
# Software Design
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
## $(( sectionNumber + 1 )). Software Design
The software is designed to work everywhere possible to be deployed painlessly to manage the target device as efficiently as possible.
EOF
esac
## Cross-platform
case "$LANG" in
en-*|*)
"$CAT" <<-EOF >> "$whitepaperPath"
## $(( sectionNumber + 1 )).1 Cross-platform support
FIXME: Decide
EOF
esac
# FIXME: The backend is currently undetermined
## Downstream
"$CAT" <<-EOF >> "$whitepaperPath"
Zernit is designed to make it efficient for it's SU to implement their own package downstream and make it available for everyone if desired.
Zernit creators are providing their own downstream with work in progress name \`zeres-0\` that is designed to provide system to process source code while giving the SU all available options to efficiently alter the build result
This downstream management is designed to provide tools that may be useful for package processing, but none of them are mandatory meaning that if desired you can run a blank file and zernit won't stop you.
To ensure the expected runtime this is expected to be enforced through provided standard per downstream repository.
## List of downstream items
Zeres-0 devices it's downstream into a \`downstream items\` each of which is designed to process diferent product.
### Packages
Used to process various source code into a package that can be imported on the target system/sandbox.
This downstream item is designed to either process the source code of the software into a package that then can be imported on the system or using pre-built binary with static options made to work on majority of devices.
In terms of database this requires following entries:
- Package Name
- Package Category
- Package Version
- Package Slot
And optionally:
- Homepage
- Upstream repository URL
- Upstream name
- Upstream organization
- License
- And anything relevant which the SU can cherrypick per system
Each package is processed through phases that are designed to each process specific part of the package where the developers have the option to specify which phases will be used to process the package meaning than none of these are mandatory at the cost of software malfunction:
- Fetch
Fetch the source code in the specified destination for processing
- Checksum check
Designed to check the checksum of fetched files that can be (if desired):
1. Checked agains virustotal database
2. Checked agains provided checksum by downstream to ensure that expected file is fetched for processing
- Cache
Designed to cache the source code tarball for processing
SU has options to:
1. Cache the tarball so if the tarball is needed zernit can get this file locally
2. Provide this file as standalone mirror that can be added to the downstream
3. Provide this file through torrent for peer-2-peer distribution
4. Provide this file through custom torrent-inspired distribution system focused on privacy and security
- Configure
Designed to configure the source code for proccessing in the \`compile\` phase
- Compile
Designed to provide backend required to process the package for compilation
- Sandbox
Designed to place the runtime in a jail that prevents the software from accessing the live userland.
- Containerize
Designed to place the content of \`IMAGE\` directory into a redistributable container that runs on the target system without the need for dependencies
To ensure compatibility this has to have a logic to determine wether it's being run on a supported system.
This can be also used for release of pre-compiled targets
- Merge
Merge the content of \`IMAGE\` directory into a live system
### Audio
Designed for distribution of audio tracks
In terms of database this requires following entries:
- Artist name
- Song name
And optionally:
- License
EOF

115
src/Cargo.lock generated Normal file
View File

@ -0,0 +1,115 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
[[package]]
name = "RXT0112"
version = "0.1.0"
dependencies = [
"clap 2.33.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "ansi_term"
version = "0.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "atty"
version = "0.2.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"hermit-abi 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)",
"libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
"winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "bitflags"
version = "1.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "clap"
version = "2.33.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)",
"atty 0.2.14 (registry+https://github.com/rust-lang/crates.io-index)",
"bitflags 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
"strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
"textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)",
"unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"vec_map 0.8.1 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "hermit-abi"
version = "0.1.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "libc"
version = "0.2.66"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "strsim"
version = "0.8.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "textwrap"
version = "0.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "unicode-width"
version = "0.1.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "vec_map"
version = "0.8.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "winapi"
version = "0.3.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [
"winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
"winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]]
name = "winapi-i686-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "winapi-x86_64-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
[metadata]
"checksum ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b"
"checksum atty 0.2.14 (registry+https://github.com/rust-lang/crates.io-index)" = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8"
"checksum bitflags 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693"
"checksum clap 2.33.0 (registry+https://github.com/rust-lang/crates.io-index)" = "5067f5bb2d80ef5d68b4c87db81601f0b75bca627bc2ef76b141d7b846a3c6d9"
"checksum hermit-abi 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)" = "eff2656d88f158ce120947499e971d743c05dbcbed62e5bd2f38f1698bbc3772"
"checksum libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)" = "d515b1f41455adea1313a4a2ac8a8a477634fbae63cc6100e3aebb207ce61558"
"checksum strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)" = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"
"checksum textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060"
"checksum unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)" = "caaa9d531767d1ff2150b9332433f32a24622147e5ebb1f26409d5da67afd479"
"checksum vec_map 0.8.1 (registry+https://github.com/rust-lang/crates.io-index)" = "05c78687fb1a80548ae3250346c3db86a80a7cdd77bda190189f2d0a0987c81a"
"checksum winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)" = "8093091eeb260906a183e6ae1abdba2ef5ef2257a21801128899c3fc699229c6"
"checksum winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
"checksum winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"

View File

@ -1,10 +1,12 @@
# FIXME-METADATA: Add metadata
[package]
name = "zernit-logger"
version = "0.0.0"
name = "RXT0112"
version = "0.1.0"
authors = ["Kreyren <KostWarCZE@RiXotStudio.cz>"]
edition = "2018"
[[bin]]
name = "main-bin"
path = "main.rs"
[dependencies]
die = "0.2.0"
clap = "*"

View File

@ -2,11 +2,4 @@
This is stub file used for various informations about the source that cannot be placed in the files itself
**FIXME:** Add Flow chart
**FIXME:** Add Dependency flow chart
**FIXME:** Add Mindmap
### References
Rust source hierarchy - https://doc.rust-lang.org/cargo/reference/manifest.html#the-project-layout
**FIXME:** Add Flow chart

View File

@ -1,28 +0,0 @@
# Reference https://doc.rust-lang.org/cargo/reference/manifest.html
[package]
name = "zernit"
description = "FIXME: description needed"
keywords = ["system-manager"]
version = "0.0.0"
authors = ["Kreyren <KostWarCZE@RiXotStudio.cz>"]
edition = "2018"
# FIXME: Implement automation that bumps the dependencies in a new commit to make it easier to track dependency-caused issues
[dependencies]
# FIXME: Replace with latest once development is in gold
clap = "2.33.0"
# Used for repository management as alternative to 'make'
cargo-make = "0.30.0"
# Used for reading toml files
toml = "0.5.6"
# Custom logging solution
zernit-logger = { path = "src/libs/rustlang/zernit-logger" }
[dev-dependencies]
# Used for benchmarking
criterion = "0.3.1"
[[bench]]
name = "example_bench"
harness = false

View File

@ -1,7 +0,0 @@
# The unnamed package manager
FIXME: We need a name (https://github.com/RXT0112/Zernit/issues/156)
Directory for the system manager source code
FIXME: Name required

View File

@ -1,5 +0,0 @@
Directory for benchmarks of the source
FIXME: Add benchmarks
FIXME: Differenciate benchmarks per programming language i.e benches/rustlang/example_bench.rs

View File

@ -1,22 +0,0 @@
use criterion::{black_box, criterion_group, criterion_main, Criterion};
/*
This is base benchmark made for consistency
FIXME-BENCH: Make cargo to recognize `benches/rustlang` path instead of `benches/`
*/
fn fibonacci(n: u64) -> u64 {
match n {
0 => 1,
1 => 1,
n => fibonacci(n-1) + fibonacci(n-2),
}
}
fn criterion_benchmark(c: &mut Criterion) {
c.bench_function("fib 20", |b| b.iter(|| fibonacci(black_box(20))));
}
criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);

View File

@ -1,14 +0,0 @@
FIXME: `main` is a place-holder -> Looking for a good name for backend resolver for zernit's backend i.e [paludis](https://paludis.exherbo.org/) using `cave`
---
# Core binary
This directory is used for core binary meaning that this binary is executed first and should resolve to required commands i.e if end-user executes `main help` expecting usage instructions then this binary should resolve the argument and execute `$repodir/src/subcoms/help` in it's appropriate place on the system once compiled (if applies) unless the language has more efficient method to handle this scenario through library alike rustlang's clap that generates the help message based on arguments provided.
## ABSTRACT
Resolve arguments to subcommands and provide backend for libraries/modules if requried
### Practical examples
end-user inputs `main help` through cli -> Display help message
end-user inputs `main resolve app-compat/wine` -> Resolve wine on end-user's system if compatible system and toolchain is used

View File

@ -1,13 +0,0 @@
#!/bin/bash
printf '%s\n' "ping"
# Argument management
while [ $# -ge 1 ]; do case $1 in
--help|-h|help)
fixme "Help message here"
shift 1
;;
*)
die 2 "FIXME: Syntax error"
esac; done

View File

@ -1,2 +0,0 @@
[ Refer to documentation of this command for further informations ]
-[------->+<]>---.+++.>+[--->++<]>++.-----------.--------.-----------.[-->+<]>+++.>-[--->+<]>-.-[--->+<]>+.+++[->+++<]>++.+++++++++++++.+++++.-------.-----------.--[--->+<]>-.+++[->+++<]>.--[--->+<]>-.-[->++++<]>--.---[->+++<]>.+++++++++++++.----.-----.+++++++++++.[---->+<]>+++.-[--->++<]>-.+++++.++++++.-----.[--->+<]>-----.[->+++<]>+.-[->+++<]>.[->+++<]>++.[--->+<]>----.+++[->+++<]>++.++++++++.+++++.--------.-[--->+<]>--.+[->+++<]>+.++++++++.

View File

@ -1,21 +0,0 @@
#include <stdio.h>
#include <string.h>
// NOTICE: Changes in this file require CI adaptation
// FIXME-TEST: Add tests
//FIXME-BENCH: Add benchmark
int main(int argc, char **argv) {
if(argc < 2) {
// FIXME: Source better help message from po depending on language used
printf("%s\n", "Argument(s) required, use -h for display help");
return 2;
} else if(strcmp(argv[1], "-h") == 0) {
printf("FIXME: %s\n", "Add optionsi");
return 1;
} else {
printf("FATAL: %s\n", "Unexpected happend while processing arguments");
return 256;
}
}

View File

@ -1,9 +0,0 @@
#include <iostream>
using namespace std;
int main() {
// Refer to the documentation
cout << "FIXME: Translate zernit into a C++++";
return 1;
}

View File

@ -1,22 +0,0 @@
// C# program to print Hello World!
using System;
// namespace declaration
namespace HelloWorldApp {
// Class declaration
class Geeks {
// Main Method
static void Main(string[] args) {
// statement
// printing Hello World!
Console.WriteLine("Hello World!");
// To prevents the screen from
// running and closing quickly
Console.ReadKey();
}
}
}

View File

@ -1,11 +0,0 @@
package main
import "fmt"
func helloworld() string {
return "Hello World!!"
}
func main() {
fmt.Println(helloworld())
}

View File

@ -1,12 +0,0 @@
/* This is a simple Java program.
FileName : "HelloWorld.java". */
class HelloWorld
{
// Your program begins with a call to main().
// Prints "Hello, World" to the terminal window.
public static void main(String args[])
{
System.out.println("Hello, World");
}
}

View File

@ -1,39 +0,0 @@
import sys
from termcolor import cprint
"""
FIXME-DOCS: Add documentation
Made for Python 3.6 ~ Python 3.8.1
Requires pip for termcolor
"""
# FIXME: Add logic to generate help message and handle arguments automatically
def cli_arg():
if len(sys.argv) == 1:
cprint("No Arguments Were Passed. Type -h to view basic usage.", "red")
exit()
# sys.arg[1] is the file itself.
elif sys.argv[1].lower() == "-h":
cprint("""
File used as bankend to parse arguments and options into subcommands
SYNOPSIS: command OPTION [SUBCOMS]
OPTIONS:
-G, --gui Open Graphical User Interface
SUBCOMS (Subcommands):
resolve resolve package on the system
""", "green")
else:
cprint("Incorrect Argument! Type -h to view basic usage.", "red")
if __name__ == '__main__':
try:
cli_arg()
except IndexError:
pass

View File

@ -1,102 +0,0 @@
// Created by Jacob Hrbek <kreyren@rixotstudio.cz> under GPL-3 license (https://www.gnu.org/licenses/gpl-3.0.en.html) in 2020
/*
File used as bankend to parse arguments and options into subcommands
SYNOPSIS: command OPTION [SUBCOMS]
OPTIONS:
-G, --gui Open Graphical User Interface
SUBCOMS (Subcommands):
resolve resolve package on the system
*/
// Sourcing
// FIXME-QA: Is this the best way to do this?
// FIXME: Source the crate based on the name in Cargo.toml
use zernit_logger::fixme;
// For argument management
use clap::{Arg, App, SubCommand};
fn main() {
fixme!("Add method to handle translations");
fixme!("Allow changing name based on config file");
fixme!("Verify that this works on POSIX");
// Capture arguments (https://docs.rs/clap/2.33.0/clap/)
// FIXME-BENCHMARK: Benchmark other option like structOpt (https://docs.rs/structopt/0.3.7/structopt/#subcommands)
// FIXME-TEST: Add test to make sure that clap works the way we want it
// FIXME: Define arguments based on their presence in src/subcoms/rustlang/<SUBCOMMAND> -- https://github.com/RXT0112/Zernit/issues/54
let matches = App::new("RXT0112")
.version("INIT_PHASE_VERSION") // Replace with valid versioning
.author("Jacob Hrbek <kreyren@rixotstudio.cz>")
.about("Work in progress package manager expected to support any kernel on any downstream")
.arg(Arg::with_name("gui")
.short("G")
.long("gui")
.multiple(true)
.help("Opens up a Graphical User Interface frontend"))
.arg(Arg::with_name("noninteractive")
.short("I")
.long("noninteractive")
.multiple(true)
.help("Opens up a Graphical User Interface frontend"))
.arg(Arg::with_name("dev")
.short("D")
.long("development")
.multiple(true)
.help("Perform all following actions in a temporary sandboxed directory used for development"))
// FIXME-QA: Sort subcommands alphabetically
.subcommand(SubCommand::with_name("resolve")
.about("Resolved package to be imported in the system")
.arg_from_usage("<category/package> 'Package identifier'"))
.subcommand(SubCommand::with_name("remove")
.about("Remove package from the system")
.arg_from_usage("-r, remove 'Removing of packages'"))
.subcommand(SubCommand::with_name("list")
.about("Listing of packages")
.arg_from_usage("-l, list 'Listing of packages'"))
.subcommand(SubCommand::with_name("deploy")
.about("deploy (WIP-NAME) on target used for initial instalation")
.arg_from_usage("-l, list 'Listing of packages'"))
// FIXME: Replace with following: .arg_from_usage("deploy 'Deploy (WIP-NAME) on target which creates required file hierarchy and configuration needed for (WIP-NAME)'"))
.subcommand(SubCommand::with_name("hijack")
.about("Import (WIP-NAME) on target system that already exists for (WIP-NAME) to be used as alternative package manager")
.arg_from_usage("-l, list 'Listing of packages'"))
// FIXME: Replace with following: .arg_from_usage("hijack 'Import (WIP-NAME) on target system that already exists for (WIP-NAME) to be used as alternative package manager'"))
.get_matches();
// Manage arguments
// NOTICE: Do not add else statement to catch unexpecteds since this is handled by clap
if matches.is_present("gui") {
unimplemented!("GUI method is not yet implemented");
} else if matches.is_present("dev") {
// WARNING: Has to be implemented prior to implementing other features
// FIXME-TEST: Make a test to ensure that features are not escaping sandbox
// FIXME: Translate in rustlang from english
fixme!("Create a new directory in tmpdir/name-of-project");
//emkdir("$TEMPDIR/RXT0112");
fixme!("Create sandboxed environment for testing of features");
unimplemented!("Development method is not yet supported");
}
// Manage subcommands
// NOTICE: Do not add else statement to catch unexpecteds since this is handled by clap
// FIXME: Convert this on 'for loop' looking for available subcommands to avoid hardcoding
// FIXME-QA: Ugly?
if let Some(_matches) = matches.subcommand_matches("resolve") {
zernit::subcoms::resolve::rustlang::resolve::resolve();
} else if let Some(_matches) = matches.subcommand_matches("list") {
zernit::subcoms::list::rustlang::list::list();
} else if let Some(_matches) = matches.subcommand_matches("deploy") {
zernit::subcoms::deploy::rustlang::deploy::deploy();
} else if let Some(_matches) = matches.subcommand_matches("hijack") {
zernit::subcoms::hijack::rustlang::hijack::hijack();
} else if let Some(_matches) = matches.subcommand_matches("remove") {
zernit::subcoms::remove::rustlang::remove::remove();
}
fixme!("Returns 0 even when no argument was parsed -> Expecting Exit 2 with help message");
}

View File

@ -1,39 +0,0 @@
#!/bin/sh
# Source kreypi's output functions
for libs in src/libs/shell/kreypi/output/*; do
. "src/libs/shell/kreypi/output/$libs"
done
# Source assertion function
. src/libs/shell/kreypi/terminators/die.sh
subcomdir="src/subcoms/shell/"
# Argument management
## NOTICE: This is used to source arguments based on filenames in subcomdir
efixme "Check security of argument management"
code=':'
for file in "$subcomdir/*"; do
[ ! -f "$file" ] && die 1 "Unable to find a file '$file' in $subcomdir "
# To avoid code injection
case $file in *[![:alnum:]]*)
die 1 "CODE_INJECTION_WARNING: Unsafe name encountered - $file" ;;
esac
code="$code | \"$file\""
done
eval "$code"
# LEGACY: Remove me once ready
# while [ $# -ge 1 ]; do case "$1" in
# --help|-h|help)
# efixme "Help message here"
# shift 1
# ;;
# command1 | command2 | command3 | command4)
# something ;;
# $(for file in src/subcoms/shell/*; do printf '%s\n' "$file | "; done)X)
# efixme "Provide logic to execute subcommands" ;;
# *)
# die 2 "FIXME: Syntax error"
# esac; done

View File

@ -1,9 +0,0 @@
// DEVELOPMENT_HALTED: Vlang's tests does not support our file hierarchy (https://github.com/vlang/v/issues/3674)
fn hello() {
printf("%s\n", "Hello World")
}
fn main() {
hello()
}

View File

@ -1 +0,0 @@
FIXME: WIP directory designed for Continuous Delivery of the source code

View File

@ -1,7 +0,0 @@
FIXME: WIP directory designed for quality assurance (also known as Continuous Integration)
FIXME: The logic should be managed by a custom management system (Should be implemented through https://github.com/RXT0113 so that it can be maintained cross-project)
FIXME: Support for TravisCI
FIXME: Support for GitHubCI
FIXME: Support for CircleCI
FIXME: Support for SourceHutCI

Some files were not shown because too many files have changed in this diff Show More