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.

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

Add flow cadence lint command #1395

Closed
jribbink opened this issue Feb 8, 2024 · 1 comment
Closed

Add flow cadence lint command #1395

jribbink opened this issue Feb 8, 2024 · 1 comment
Assignees
Labels
Feature A new user feature or a new package API Improvement Technical work without new features, refactoring, improving tests

Comments

@jribbink
Copy link
Contributor

jribbink commented Feb 8, 2024

Instructions

Please fill out the template below to the best of your ability.

Issue To Be Solved

Currently, the Cadence linter is only really surfaced through the language server & adjacent tools (VSCode extension, playground). It is a valuable static-analysis tool which could be a part of automation processes and developers may want to run it independently (outside of integration with the aforementioned tooling).

We should surface this as a command in the Flow CLI so that developers can enforce better standards within their Cadence code and catch errors earlier in their development cycle.

(Optional): Suggest A Solution

Add a flow cadence lint <files> command which runs all linting analyzers as and surfaces these to the output. The command should also attempt to surface any parsing/checking errors in a structured format.

(Optional): Context

This relates to efforts related to Cadence 1.0 and helps developers understand if problems exist in their code, what these problems are, and how they can attempt to mediate them.

related: onflow/cadence-tools#285

@jribbink jribbink added Feature A new user feature or a new package API Improvement Technical work without new features, refactoring, improving tests labels Feb 8, 2024
@jribbink jribbink self-assigned this Feb 8, 2024
@jribbink jribbink moved this to 🏗 In Progress in 🌊 Flow 4D Feb 8, 2024
@turbolent
Copy link
Member

That would be great! Similarly, it would be great to expose the docgen tool and the test tool (might already be not sure)

@jribbink jribbink moved this from 🏗 In Progress to 👀 In Review in 🌊 Flow 4D Mar 14, 2024
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in 🌊 Flow 4D Mar 18, 2024
@gregsantos gregsantos moved this from ✅ Done to Closed (Cycle 2) in 🌊 Flow 4D Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature A new user feature or a new package API Improvement Technical work without new features, refactoring, improving tests
Projects
Archived in project
Development

No branches or pull requests

2 participants