stacks-foundation
commented
1 year ago 👋 @njordhov Thanks for your application! We will do a pre-review and let you know if we have any immediate questions. In the mean time please refer to our review schedule here for a detailed timeline and response dates. Best, Will
njordhov
friedger
APPLICANT
Type: Direct Application
Email: terje@in-progress.com
Discord:
Twitter:
Stacks Forum:
GRANT BASICS
Grant Name: Clarity Linter & Formatter
Total Budget: 25,000
Total Duration: 100
Grant Type: Open Source Dev Repeat Grantees
Grant Track: Stacks Developer Experience
Grant Goal: Create New Technology
Grant Audience: Developers
Specific Audience: Clarity contract developers and Stacks toolkit developers
Grant Team: njordhov
Previous Grants: https://github.com/njordhov/clarity-sequence
Ecosystem Programs:
GRANT MISSION, IMPACT, RISKS & REFERENCE
Grant Mission: Develop an open-source auto-correcting linter and code formatter for Clarity. It analyzes Clarity contracts for code violations, automatically resolves syntax errors, structural issues, and best practices violations. Its autoformatter will tidy up the layout and formatting of contracts, ensuring a consistent style for more readable code.
Grant Impact: Consistent contract formatting improves code readability, allowing more users including non-developers to participate in reviewing contracts and performing security auditing, take ownership and perhaps learn by example how to write their own contracts. It will help developers be more productive in implementing Clarity contracts that (hopefully) bring us closer to a user-owned internet.
Grant Risks: Scope creep is a concern: There are unlimited possibilities for code to be malformed, improved, and corrected. To avoid scope creep, the project will be limited to implement essential linting rules, while providing ways to extend the linter with new rules and customization.
Support Link: Project repository
GRANT ROADMAP & DELIVERABLES
MILESTONE 1:
Deliverable: 1) Command line linter and formatting tool for Clarity contracts, validating contracts and automatically fixing code issues, including ensuring syntactically correct and grammatically wellformed code, with consistent style and layout.
MILESTONE 2:
Deliverable: Software processing a Clarity contract, reporting and/or fixing syntax errors while formatting the result with consistent layout and style.
FINAL DELIVERABLE
Deliverable: Develop an open-source auto-correcting linter and code formatter for Clarity. It analyzes Clarity contracts for code violations, automatically resolves syntax errors, structural issues, and best practices violations. Its autoformatter will tidy up the layout and formatting of contracts, ensuring a consistent style for more readable code.