Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Setup all the config files #13 #17

Open
wants to merge 4 commits into
base: rmenner/dev-command
Choose a base branch
from
Open

Setup all the config files #13 #17

wants to merge 4 commits into from

Conversation

rmenner
Copy link
Collaborator

@rmenner rmenner commented Nov 22, 2024 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Set up and update various configuration files, including GitHub settings, workflows, and package.json, to improve project structure and documentation. Add a README.md file to provide comprehensive usage instructions for the Auro CLI.

New Features:

  • Introduce a README.md file to provide an overview and usage instructions for the Auro CLI.

Enhancements:

  • Update package.json to include new dependencies and devDependencies, and reorganize the structure for better clarity.
  • Refactor eslint.config.js to use the latest ESLint configurations and plugins, enhancing code quality checks.

CI:

  • Modify GitHub Actions workflows to ensure consistent formatting and style in YAML files.

Documentation:

  • Add a README.md file to document the Auro CLI, including installation, usage, commands, options, and examples.

@rmenner rmenner self-assigned this Nov 22, 2024
@rmenner rmenner requested a review from a team as a code owner November 22, 2024 03:58
@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Nov 22, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This PR sets up the project's configuration files and development environment. The changes include setting up ESLint with Prettier integration, configuring GitHub workflows and settings, adding package.json configurations, and establishing project documentation and license files.

Class diagram for updated ESLint configuration

classDiagram
    class ESLintConfig {
        +languageOptions: Object
        +rules: Object
    }
    class BabelParser {
        +requireConfigFile: Boolean
        +babelOptions: Object
    }
    ESLintConfig --> BabelParser : uses
    note for ESLintConfig "Updated to use Babel parser and Prettier plugin"
    note for BabelParser "Configured with @babel/preset-env"
Loading

File-Level Changes

Change Details Files
Set up ESLint and Prettier configuration
  • Configured ESLint with @aurodesignsystem/eslint-config
  • Added Babel parser configuration
  • Integrated Prettier with ESLint
  • Disabled console warnings in ESLint rules
 eslint.config.js
Enhanced package.json configuration
  • Added development dependencies for linting and commit conventions
  • Configured lint-staged for code quality checks
  • Added project metadata and keywords
  • Updated license to Apache-2.0
  • Added engine requirements for Node.js
 package.json
Added project documentation and license files
  • Created comprehensive README with installation and usage instructions
  • Added LICENSE and NOTICE files
  • Added .editorconfig for consistent coding style
  • Updated contribution guidelines with conventional commits format
 README.md
LICENSE
NOTICE
.editorconfig
.github/CONTRIBUTING.md
Configured GitHub repository settings
  • Updated issue templates with structured formats
  • Configured CodeQL security analysis workflow
  • Added stale issue handling configuration
  • Updated repository labels and their descriptions
 .github/settings.yml
.github/workflows/codeql.yml
.github/stale.yml
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
Set up commit message validation
  • Added commitlint configuration
  • Configured Husky for git hooks
  • Set up commit message format rules
 commitlint.config.cjs
.husky/commit-msg
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rmenner rmenner linked an issue Nov 22, 2024 that may be closed by this pull request
Address auro-cli repository configuration(s) #13
Open
sourcery-ai[bot]
sourcery-ai bot reviewed Nov 22, 2024
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @rmenner - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The 'Type: UI Update' label in settings.yml has 'dependencies' listed as an alias which seems incorrect and should probably be removed or replaced with UI-related aliases
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

eslint.config.js Outdated Show resolved Hide resolved
eslint.config.js Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@jason-capsule42 jason-capsule42 jason-capsule42 approved these changes

Assignees

@rmenner rmenner

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Address auro-cli repository configuration(s)
2 participants
@rmenner @jason-capsule42