athennaio / cli

⌨️ Athenna CLI to create new projects and install components. Built with Athenna.

AthennaIO 🦴

The Athenna scaffold project used by 'athenna new project' command to create your project.

Links

For project documentation click here. If something is not clear in the documentation please open an issue in the documentation repository

Contributing

If you want to contribute to this project, first read the CONTRIBUTING.MD file. It will be a pleasure to receive your help.

---

With 💜 by Athenna community

cli's Issues

[Bug]: Remove replicaSet option from MongoDB config

Version

1.3.1

Steps to reproduce

1 - Use the athenna install:database --type=mongo
2 - Run docker-compose up -d
3 - Try to run the application. MongoDB will never connect.

Expected behavior

Expected to run the application without problem when the connection is right.

Actual behavior

The MongoDB never connect because he does not find the replica set.

Additional context

No response

Environment

System:
    OS: Linux 5.14 Ubuntu 20.04.5 LTS (Focal Fossa)
    CPU: (8) x64 11th Gen Intel(R) Core(TM) i5-1145G7 @ 2.60GHz
    Memory: 6.19 GB / 15.03 GB
    Container: Yes
    Shell: 5.8 - /usr/bin/zsh
  Binaries:
    Node: 16.18.0 - ~/.nvm/versions/node/v16.18.0/bin/node
    npm: 8.19.2 - ~/.nvm/versions/node/v16.18.0/bin/npm

[Feature]: Implement update command

🚀 Feature Proposal

Implement the athenna update command.

Motivation

This command will update the CLI to the latest version by running the npm install -g @athenna/cli.

Example

No response

Getting `/usr/bin/env: invalid option -- 'S'` when I run `athenna new`

Version

latest

Steps to reproduce

I followed the docs at https://athenna.io/docs/getting-started/installation and did npm install -g @athenna/cli

But then running athenna new athenna-project --type httpshows the following error in terminal:

/usr/bin/env: invalid option -- 'S'

Expected behavior

A new project created

Actual behavior

error shown: /usr/bin/env: invalid option -- 'S'

Additional context

No response

Environment

System:
    OS: Linux 5.4 Ubuntu 18.04.6 LTS (Bionic Beaver)
    CPU: (8) x64 Intel(R) Core(TM) i7-8565U CPU @ 1.80GHz
    Memory: 3.66 GB / 7.65 GB
    Container: Yes
    Shell: 4.4.20 - /bin/bash
  Binaries:
    Node: 16.20.0 - /usr/local/bin/node
    Yarn: 1.17.3 - /usr/local/bin/yarn
    npm: 8.19.4 - /usr/local/bin/npm

[Feature]: Change Athenna clone URL to AthennaIO/AthennaIO

🚀 Feature Proposal

When the issue #77 is merged, we will need to change the end of the repository clone URL from AthennaIO/Scaffold to AthennaIO/AthennaIO.

Motivation

If this change is not done after the merge, the CLI will stop working.

Example

No response

[Bug]: Not working on Windows

Version

3.1.1

Steps to reproduce

1 - In a Windows OS run npm install @athenna/cli -g
2 - athenna

Expected behavior

Expected that the athenna cli works perfectly.

Actual behavior

& : The term '-S.exe' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the
spelling of the name, or if a path was included, verify that the path is correct and try again.
At C:\Users\Usuário\AppData\Roaming\npm\athenna.ps1:24 char:7
+     & "-S$exe" node --experimental-import-meta-resolve "$basedir/node ...
+       ~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (-S.exe:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

Additional context

No response

Environment

System:
    OS: Windows 10 10.0.22621
    CPU: (12) x64 AMD Ryzen 5 5600X 6-Core Processor
    Memory: 10.34 GB / 15.93 GB
  Binaries:
    Node: 18.13.0 - C:\Program Files\nodejs\node.EXE
    npm: 8.19.3 - C:\Program Files\nodejs\npm.CMD

[Feature]: standardize versions control

🚀 Feature Proposal

Standardize package.json dependencies version control and auto-update.

Motivation

Manual dependencies versions updates.

Example

If in package.json the @athenna/artisan version is 1.ˆ and has a new version 1.0.1, the next time that the npm I command has been run, it will auto-update the artisan to the latest version.

[Feature]: recreate the project using Athenna

🚀 Feature Proposal

The CLI is an outside project of Athenna. It’s a good example of a project that could be created using the ’cli’ project type of Athenna.

Motivation

The project will use a framework to support more functionalities and be more organized.

Example

No response

[Bug]: Mail component with invalid enviroment variables

Version

1.3.1

Steps to reproduce

Run the athenna install:mail

Expected behavior

I expect to see the right MAIL_PORT variable in config/mail.js and also see the MAIL_MAILER env variable in .env... files.

Actual behavior

MAIL_PORT is set as MAIL_POST and MAIL_MAILER is not present in .env... files.

Additional context

No response

Environment

System:
    OS: Linux 5.14 Ubuntu 20.04.5 LTS (Focal Fossa)
    CPU: (8) x64 11th Gen Intel(R) Core(TM) i5-1145G7 @ 2.60GHz
    Memory: 6.19 GB / 15.03 GB
    Container: Yes
    Shell: 5.8 - /usr/bin/zsh
  Binaries:
    Node: 16.18.0 - ~/.nvm/versions/node/v16.18.0/bin/node
    npm: 8.19.2 - ~/.nvm/versions/node/v16.18.0/bin/npm

[Feature]: Implement version validator

🚀 Feature Proposal

Implement a version validator when running any athenna CLI command.

Motivation

This validator needs to check the local version of the @athenna/cli which the developer is using and compare with the version of package.json file in the repository.

If the version is not equals, then a warning needs to be thrown or maybe, we can just explain that he is using an old version and Athenna will install a newer one by running the athenna update command.

Example

No response

[Bug]: DB_PORT variable with value undefined when using Mongo

Version

1.3.1

Steps to reproduce

1 - Use the athenna install:database --type=mongo
2 - The DB_PORT env variable generated in .env... files has the value undefined.

Expected behavior

It is expected that the DB_PORT variable has the value 27017.

Actual behavior

The DB_PORT env variable generated in .env... files has the value undefined.

Additional context

No response

Environment

System:
    OS: Linux 5.14 Ubuntu 20.04.5 LTS (Focal Fossa)
    CPU: (8) x64 11th Gen Intel(R) Core(TM) i5-1145G7 @ 2.60GHz
    Memory: 6.19 GB / 15.03 GB
    Container: Yes
    Shell: 5.8 - /usr/bin/zsh
  Binaries:
    Node: 16.18.0 - ~/.nvm/versions/node/v16.18.0/bin/node
    npm: 8.19.2 - ~/.nvm/versions/node/v16.18.0/bin/npm