onezerocompany/coding

Coding guides and tools for OneZero

coding's Issues

Run pre-commit hook at the end if skipped in the beginning

Determine next version number for release issues

We still need to built in a system that fetches the list of current releases and based on that determines the next version

Firebase emulator image for devcontainers

Since we have several projects that require the Firebase emulators to develop, we should publish an image that can be used by all projects.

Implement @eslint-plugin-jsdoc

Add @eslint-plugin-jsdoc to the eslint configs enforcing proper documentation of the code that is being written.

Rules to implement:

• check-access
• check-alignment
• check-examples
• check-indentation
• check-line-alignment
• check-param-names
• check-property-names
• check-syntax
• check-tag-names
• check-types
• check-values
• empty-tags
• implements-on-classes
• match-description
• match-name
• multiline-blocks
• newline-after-description
• no-bad-blocks
• no-defaults
• no-missing-syntax
• no-multi-asterisks
• no-restricted-syntax
• no-types
• no-undefined-types
• require-asterisk-prefix
• require-description-complete-sentence
• require-description
• require-example
• require-file-overview
• require-hyphen-before-param-description
• require-jsdoc
• require-param-description
• require-param-name
• require-param-type
• require-param
• require-property
• require-property-description
• require-property-name
• require-property-type
• require-returns-check
• require-returns-description
• require-returns-type
• require-returns
• require-throws
• require-yields
• require-yields-check
• sort-tags
• tag-lines
• valid-types

Update status on release/tag deletion

When a release gets deleted this should update the release issue

Add node plugin to ESLint configs

Since we write a bunch of code that runs on Node.js, we should add rules to ESLint that check for things we might be doing wrong in relation to Node.js.

💡 README generator

Feature Description

🗂 What part of the app does the feature apply to?
Documentation

💡 What problem does the feature solve?
Having to spend a lot of time creating README files for each project.

📖 How should we implement the feature?
Create a simple node CLI tool that generates the README based on a YAML file in the project.

VS Code commit extension

Since most of our development if not all happens within VS Code it would be very nice to have a visual tool that helps us commit. Since we already have a tool that works in the command line, we can use that and add an extension layer on top of it.

Fix OneZero theme syntax colors

The syntax colors are not being correctly displayed

🚀 Release 1.8.0

Stable

Feature Improvements
- improve body editor

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

Improve changelogs on releases

When creating releases, the changelogs should be improved to match the changelog that was specified in the release issue before approving the creation of the release

🚀 Release 1.5.0

Stable

- minor bug fixes and improvements

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

💡 Commit Tool

Feature Description

🗂 What part of the app does the feature apply to?
Git

💡 What problem does the feature solve?
When writing commit messages, it's easy to change how you write them over time. It's also hard to interpret the commit messages with other scripts when they don't follow a pre-defined template.

📖 How should we implement the feature?
We should make a tool using Deno and compile those to binaries that can be run on each development environment. Developers should then use these to write and validate their commit messages. OneZero should also use git hooks to prevent committing anything that doesn't follow the guidelines we coded into the tool.

---

Additional Information

📱 Which platforms/devices does this feature apply to?
macOS, Linux, and Windows (all the places a developer could write code)

📝 Additional notes on the feature that are important
We must provide additional tools that can use these commit messages to bump versions and create changelogs.

---

✅ Feature Checklist

• Assigned priority to this issue (including labels)
• Tag this issue with the correct labels (remove needs-labels too)
• Added this issue to the project board
• Create a feature/{feature-name} branch
• #3
• #2
• Changelog generation
• Categories listing

Block release when there is no version bump

When there is no version bump to be done, do not create a release issue.

Other things to do:

• Change category CI to bump a patch version, in case the CI changes the way software is published or packaged.

Feature: TSConfigs

Feature Description

🗂 What part of the app does the feature apply to?
Config packages

💡 What problem does the feature solve?
Deciding how to configure the TypeScript compiler can take some time to get it right.

📖 How should we implement the feature?
Publish multiple packages that contain pre-configured TSConfigs that can then be extended upon.

---

Additional Information

📱 Which platforms/devices does this feature apply to?
all

📝 Additional notes on the feature that are important

---

✅ Feature Checklist

• Assigned priority to this issue (including labels)
• Tag this issue with the correct labels (remove needs-labels too)
• Added this issue to the project board
• Create a feature/{feature-name} branch

💡 Dart Linter Config

Feature Description

🗂 What part of the app does the feature apply to?
Linter Configs

💡 What problem does the feature solve?
Keeping a consistent code format across our Flutter based projects.

📖 How should we implement the feature?
We should provide a YAML file through a RAW url on GitHub that can then be referenced in the config of the dart linter.

---

Additional Information

📱 Which platforms/devices does this feature apply to?
All platforms

📝 Additional notes on the feature that are important
We need to make sure it can be used from both VSCode and GitHub Actions

---

✅ Feature Checklist

• Assigned priority to this issue (including labels)
• Tag this issue with the correct labels (remove needs-labels too)
• Added this issue to the project board
• Create a feature/{feature-name} branch

🚀 Release 1.8.1

Stable

- minor bug fixes and improvements

• ✅ Changelog approved
• ⏳ Waiting for clearance (check the box to release)
• 🚦 Waiting for release clearance

Pre-install bun inside Dev Container

Since we are going to transition most Node.js code to Bun, it would improve development time to pre-install the binary inside the container

Fix setup-flutter path

The setup-flutter action does not correctly link the path to the flutter command making it unreachable from the ci scripts.

💡 Checklist Action

Feature Description

🗂 What part of the app does the feature apply to?
actions

💡 What problem does the feature solve?
Keeping issues tidy is a real hassle and requires a lot of work, so we should lighten this load by automating as much as possible.

📖 How should we implement the feature?
Make an action that can be run on issue creation, and change.

---

Things to implement:

Issue & PR comment

Create a comment on the issue or pull request that is used to track the progress and to indicate what still needs to happen to it for it to be valid.

Remember successful run of pre-commit hook

When running the commit tool a second time because for instance a value was entered incorrectly, the pre-commit hook can be automatically skipped since it already ran successfully the first time (if the code hasn't changed since).

We should write to a dot file that contains a hash of the files and checks if they are still the same since the last successful run, and if they are still the same, skip the pre-commit hook step.

Originally posted by @lucasilverentand in #70 (comment)

🐞 Hook skipping broken

Bug Description

🐜 Describe the bug
When using the --skip-hooks option on the create command within the commit tool, it does not skip the hooks.

🐞 First line can be too long for GitHub in commit tool

Bug Description

🐜 Describe the bug
When using the commit tool for authoring commit messages the first line can become too long.

🗂 What part of the app does the bug affect?
commit creation

📝 Steps to reproduce the behavior

1. run npx @onezerocompany/commit create
2. go through the process of filling in the details
3. at the scope fill in the max length scope
4. at the subject fill in the max length subject
5. the first line will be longer than the allowed limit on GitHub and be cut-off

🧐 What is the expected behavior
The first line should be limited to the limit of 72 characters.

---

Prioritization

📈 What priority would you give this bug?
Medium, as the pull request will be rejected when using a too-long first line

Command for creating commits

What does the tool have to do

The prompt tool in onezero-commit needs to ask a couple questions and then compile the commit message and apply it to the current ongoing commit.

Questions to implement:

• category (from categories.yaml file)
• scope (short lowercase string between 3-20 chars, no special chars, no numbers)
• subject (between 10 - 48 chars, all lowercase no dot at the end)
• body (long text with no rules except start with uppercase and end with dot, optional)
• breaking (yes/no, if yes body must be filled otherwise run body again)
• issues (list of numbers)
• co-authors (list of GitHub users)
• signing off
• file selector for commit

none of the values should have multiple whitespace or empty lines, also all values should be trimmed.

Feature: ESLint Configs

Feature Description

🗂 What part of the app does the feature apply to?
Published packages

💡 What problem does the feature solve?
ESLint will keep the coding style of Javascript and Typescript files consistent across multiple projects, teams, and developers. It can also be automated to make sure all repositories comply.

📖 How should we implement the feature?
Publish the @onezerocompany/eslint-config package to GitHub Packages that contains the shared config for all projects.

---

Additional Information

📱 Which platforms/devices does this feature apply to?
macOS & Linux (for now)

📝 Additional notes on the feature that are important
The package might need to be split up into multiple smaller ones that contain only parts of the config to optimize the runtime of ESLint and potentially also increase the compatibility with other projects.

---

🐙 GitHub Checklist

• Assigned priority to this issue (including labels)
• Tag this issue with the correct labels (remove needs-labels too)
• Added this issue to the project board
• Create a feature/{feature-name} branch

✅ Feature Checklist

• add rules for javascript
• add rules for typescript
• add rules for react
• support Deno
• support Node
• support chai, mocha
• include import plugin
• keep filenames correct

Setup-Flutter Action

We need to use the flutter SDK in a bunch of workflows. That's why an action that makes it easy to setup Flutter & Dart easily on any platform. There should also be support for caching and authentication to pub.dev

• Downloading and Installing Flutter + Dart
• Fetching the latest automatically
• Specifying specific channel + version
• Setting up authentication

Dart Linter Config

💡 Legal Document Generator

Feature Description

🗂 What part of the app does the feature apply to?
Legal documents

💡 What problem does the feature solve?
All of our apps require legal documents like Terms of Agreement and Privacy Policies. It can be very time consuming to come up with all the documents for them. That's why we should make a generator that can generate those documents for us.

📖 How should we implement the feature?
We should come up with a yaml schema that can be used to define what things an app accesses and does to then generate the legal documents, also we should integrate those with fastlane to then update the App Store details.

---

Additional Information

📱 Which platforms/devices does this feature apply to?

📝 Additional notes on the feature that are important

---

✅ Feature Checklist

• Assigned priority to this issue (including labels)
• Tag this issue with the correct labels (remove needs-labels too)
• Added this issue to the project board
• Create a feature/{feature-name} branch

Remove file limit on changes

When creating a commit using the commit tool, there is a limit on how many files can be selected, this should be removed since often a change might update more files at the same time.

🐞 No changed files case for commit tool

Bug Description

🐜 Describe the bug
Currently having no changed files in a git environment makes the tool crash. It should actually exit gracefully and even skip the pre-commit hooks aswell.

🚀 Release 1.9.1

Stable

Bug Fixes
- fix missing docker entrypoint

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

🚀 Release 1.6.0

Stable

New Features
- add vscode theme for onezero

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

Feature: Prettier Config

Feature Description

🗂 What part of the app does the feature apply to?
Configs

💡 What problem does the feature solve?
In order to keep consistent formatting across many different file types and projects, we should use the Prettier code formatter. It's opinionated and consistent meaning we don't have to come up with all the rules and many other projects already use it, which in turn makes it easier for other developers to join our projects since they will be used to the formatting.

📖 How should we implement the feature?
Provide a config for prettier that can be consumed as an NPM package that makes sure we use the same settings across all projects.

---

✅ Feature Checklist

• Assigned priority to this issue (including labels)
• Tag this issue with the correct labels (remove needs-labels too)
• Added this issue to the project board
• Create a feature/{feature-name} branch

🚀 Release 1.8.2

Stable

- minor bug fixes and improvements

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

🚀 Release 1.8.3

Stable

- minor bug fixes and improvements

• ✅ Changelog approved
• ⏳ Waiting for clearance (check the box to release)
• 🚦 Waiting for release clearance

🚀 Release 1.5.0

Stable

New Features
- add fallback logic for settings

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

Setup release-issues in coding repository

Since the release-issues action should be ready for use outside the testing repository, we should implement it here in the coding repository.

🚀 Release 1.9.0

Stable

New Features
- add docker inside devcontainer

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

📘 Coding Guides

These are the guides we still need to write

• Getting started with code signing
• Setting up the coding environment

🐞Create tool fails with git environment

Bug Description

🐜 Describe the bug
The create tool fails to start when there is no git repo yet. This case should be handled gracefully instead of not working.

🗂 What part of the app does the bug affect?
commit creation

📝 Steps to reproduce the behavior

1. open an empty folder without git repo.
2. run the 'commit create' command

Release manifests

When creating a release a release-manifest.json should be included that contains all the details of the release as it was specified in the release issue.

🆕 Release tracker issue action

Feature Description

🗂 What part of the app does the feature apply to?
Release creation

💡 What problem does the feature solve?
When working on an app, we need to publish many updates. By offloading the task of creating releases to an automated system, we can keep the development momentum much higher.

📖 How should we implement the feature?
We need to develop an action that creates issues per release, which in turn can be used to release the version to different release tracks (alpha, beta, release).

The issue tracker should write a comment which has checkmarks that can be ticked (but only by approved users) otherwise the comment automatically reverses the checkmark.

Logic flow:

1. Get the commit comments and extract changes since the last release
2. Calculate the version bump to do
3. Stop in case there is no release to be done
4. Create an issue tracker comment
5. Update on each comment and create releases accordingly

Assign issue to users specified in the settings for the release issues

When creating an issue it should also be assigned to a list of users that were specified in release issues settings file.

Pull Request commit checks

We should make a GitHub Action that checks all the commit messages on a pull request. This way, we can easily assure that only commits that comply with our rules can be committed.

🚀 Release 1.7.0

Stable

Feature Improvements
- block non bumping issues

• ✅ Changelog approved
• ✅ Release was cleared
• ✅ Release was created successfully

Close issue when all items are successful or skipped

When all items in an issue are either successful or skipped it should close the issue automatically

Check if there are updates to pull before creating commit

When creating a commit with the commit tool, ask to first pull and continue

🌡 Code Climate

General CLI implementation

We need to add a general help message and define the commands that can be run with the onezero-commit CLI.

Create releases using different token

When creating releases using the release-issues action, a different API token should be used to make sure that the actions after creating the release get run. Because GitHub prevents actions being triggered from anything another action does.