jooaodanieel / dk-assist Goto Github PK

DKAssist has automatic releases with a GitHub Actions workflow.

But currently it only supports Linux and Mac releases -- see the workflow definition

In this issue, we're asking for contributions to
create an automatic release of DKAssist for Windows via GitHub Actions

note: don't forget to update the README accordingly 🚀

DKAssist is available at the AUR for an easier installation for arch-linux-based OS.
But, the process of releasing is done manually.

In this issue, we're asking for contributions to
automate this process via GitHub Actions

note: don't forget to update the README accordingly 🚀

DKAssist supports listing required files and specifications of environment variables.

When there is any variable specified in the envSample block, DKAssist shouldn't need .env to be listed under requiredFiles.

In this issue, we're asking for contributions to
automatically inferring that .env is required when there is information in the envSample block

note: don't forget to update the README accordingly 🚀

DKAssist supports the scaffold command, that reads the configuration and generate all the required files.

In particular, it pre-populates the .env with the data in the config.

In this issue, we're asking for contributions to
a new command update that adds to .env only the missing variables

For example, suppose this is the state of a repository

Assistfile.json

{
  ...
  "envSample": [
    {
      "name": "DATABASE_CONNECTION_URL"
    },
    {
      "name": "CORS_ENABLED",
      "description": "The address(es) enabled by CORS",
      "default": "*"
    }
  ]
}

.env

# The address(es) enabled by CORS
CORS_ENABLED="*"

In this case, note the variable DATABASE_CONNECTION_URL is listed in Assistfile.json, but it's missing from .env.

Then, running dk-assist update would change .env file to be

.env post-update

# The address(es) enabled by CORS
CORS_ENABLED="*"

DATABASE_CONNECTION_URL=

note: don't forget to update the README accordingly 🚀

When the project already have a required file, the program overwrite the required file even if its already exists

DKAssist works based on a config file placed at the root folder.
Although, sometimes we're running commands from a deeper directory.

In this issue, we're asking for contributions to
search the config file in the current directory and recursively in the parent

note: don't forget to update the README accordingly 🚀