practicalli / practicalli/clojure

spec for deps.edn files

Open
#62 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

spec testing
Dominant language
Makefile
Stars
117
Forks
36
PR merge metrics
No merged PRs in 30d

Description

whether deps.edn can be spec'ed so that if one makes a mistake (e.g., putting a string literal where a symbol is expected), the cli tools can give some kind of feedback on the said mistake as spec errors. has the core team considered this?

alexmiller Yesterday at 23:40
It’s not currently checked as we were trying to support older Clojure versions although we could probably bump that req now
2 replies
Salam 24 hours ago
aha, indeed:
https://github.com/clojure/tools.deps.alpha/blob/master/src/main/clojure/clojure/tools/deps/alpha/specs.cljyeah, being able to leverage this in clojure 1.10.x (or later versions) would be great.i'll settle for the comment form at the bottom of that spec file for now. 🙂 thanks! (edited)
src/main/clojure/clojure/tools/deps/alpha/specs.clj

; Copyright (c) Rich Hickey. All rights reserved.
; The use and distribution terms for this software are covered by the
; Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
; which can be found in the file epl-v10.html at the root of this distribution.
; By using this software in any fashion, you are agreeing to be bound by

https://github.com/clojure/tools.deps.alpha|clojure/tools.deps.alphaclojure/tools.deps.alpha | Added by GitHub
alexmiller 24 hours ago
Yeah, I used that to validate all the deps.edn I had lying around :)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading src/main/clojure/clojure/tools/deps/alpha/specs.clj, which the issue references, then trace how the CLI tools process deps.edn. Define the validation scope and confirm that invalid values such as a string where a symbol is expected produce useful spec feedback; account for the Clojure version requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.