Skip to content

Commit

Permalink
deploy: 6bacc7b
Browse files Browse the repository at this point in the history
  • Loading branch information
Kakadu committed Jul 25, 2024
1 parent aac3ab5 commit 4b038a5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions lints/lints.json
Original file line number Diff line number Diff line change
Expand Up @@ -328,5 +328,16 @@
"is_multi_part_suggestion": false,
"applicability": "Unresolved"
}
},
{
"id": "lint_filesystem",
"group": "correctness",
"level": "deny",
"impl": "typed",
"docs": "### What it does\nChecks that dune project tree is well formed\n\n### Why is is important?\n\nAll modules should have .mli interfaces.\nThe .mli files allow to\n\n* hide some structure items\n* write documentation for modules.\n* hide dependencies between modules (i.e. speedup compilation)\n\nWithout .mli files all your functions will be 'public' in the sence of C++ style OOP.\nUsually people autogenerate .mli files and all defined values in that time become public.\nZanuda is able to detect this via `zanuda -unused-decls .`.\nBut in some cases, .mli files may be too heavy, for example, when we write many type\ndeclarations (sort of AST) with deriving attributes.\nIn that case .mli file is almost identical to .ml.\nTo workaround this, this check allows file with a suffix 'ast.ml' not to have an .mli interface file.\n\nTODO: Add custom configuration for this.",
"applicability": {
"is_multi_part_suggestion": false,
"applicability": "Unresolved"
}
}
]

0 comments on commit 4b038a5

Please sign in to comment.