Comments (10)
@JoshuaKGoldberg Maybe add the markdownlint-rule
keyword to your package so it shows up here for other people to find: https://www.npmjs.com/search?q=keywords:markdownlint-rule
@JoshuaKGoldberg You may be able to use the markdownlint-rule-helpers
package to remove the dependency of your rule on internals of the linter: https://www.npmjs.com/package/markdownlint-rule-helpers
@JoshuaKGoldberg I added a note to the issue above to address one of the concerns therein.
Everyone: The .markdownlint.json
configuration file is exclusively for configuring rules, so that doesn't help the scenario above. However, I created an alternate version of the CLI that is entirely configuration-file-based. This scenario where it's not convenient to update the caller of the tool is sort of kind of what I had in mind when I created it. Perhaps that could help: https://github.com/DavidAnson/markdownlint-cli2
Everyone: you may also be interested in this issue with a somewhat more detailed discussion of line breaking: DavidAnson/markdownlint#298
from helm-charts.
It would be an honor to have my teeny markdownlint rule used here
from helm-charts.
@scottrigby nice references! I like the article linked from denver.org https://rhodesmill.org/brandon/2012/one-sentence-per-line/
I agree that semantic line breaks / one sentence per line makes it easier to review changes.
I have no experience with linters to enforce it.
A good start would be to disable rules which force line breaks after 80 characters when linting markdown.
from helm-charts.
@scottrigby I like the semantics breaks. It's also easy on eyes, doesn't need to read a statement twice to make sense of.
Here's my +1 on this.
from helm-charts.
Could we add this as a requirement to the ci pipeline / linter maybe?
If so, sounds good to me :)
from helm-charts.
It would be an honor to have my teeny markdownlint rule used here and I would be happy to support as needed!
@JoshuaKGoldberg Do you know if it's possible to in include your rule in https://github.com/github/super-linter?
Markdownlint is called here: https://github.com/github/super-linter/blob/c58bab262756890004e5bbb3cf8744ed1e6174c4/lib/linter.sh#L1646
from helm-charts.
π no, it looks like it's not possible to include custom -r
/--rules
markdownlint rules in super-linter right now. I'll defer to @DavidAnson as to whether there's any interest in allowing those rules to be configured via the config file.
Alternately, maybe super-linter could take an issue to allow configuring those things? I haven't used it enough to know their project ethos very well.
from helm-charts.
@JoshuaKGoldberg pointed me here JoshuaKGoldberg/sentences-per-line#6 and said it should be doable, the rule is basically a glorified regular expression
from helm-charts.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Any further update will cause the issue/pull request to no longer be considered stale. Thank you for your contributions.
from helm-charts.
This issue is being automatically closed due to inactivity.
from helm-charts.
Related Issues (20)
- [kube-prometheus-stack] grafana okta sso setup
- [Prometheus-adapter] Does Prometheus-adapter support scraping custom metrics for windows pods to implement HPA.
- [kube-prometheus-stack] How to set kube-prometheus-stack Grafana sidecar containers resource limit? HOT 4
- [prometheus-stackdriver-exporter] Deployment metadata missing annotations
- [kube-state-metrics] DaemonSet option missing
- [kube-prometheus-stack] unknown field "automountServiceAccountToken" HOT 1
- [kube-prometheus-stack] override image repository from helm command line (--set) not working HOT 2
- [kube-prometheus-stack] no specific registry key of .Values.prometheusOperator.admissionWebhooks or .patch is respected if global.registry is set
- [prometheus-elasticsearch-exporter] image.pullSecret not taken into account HOT 2
- [kube-prometheus-stack] Networking NO DATA HOT 4
- [prometheus-windows-exporter] Readiness probe always returning 404 HOT 1
- [prometheus] How to set podLabels for the remaining pods (alertmanager, node-exporter, pushgateway, etc.) HOT 1
- [kube-prometheus-stack] Wrong Grafana default E-Mail
- [kube-prometheus-stack] retentionSize is not taken into effect HOT 1
- [prometheus-kube-stack] gcfsd filesystem has less than 5% space left
- [kube-prometheus-stack] Node Exporter Job name changed after upgrade fro 61.2.0 to 62.1.0 HOT 4
- [kube-prometheus-stack] Issue with Metric to fetch k8's cluster nodes memory usage HOT 1
- [kube-prometheus-stack] Issue with the Prometheus upgrade from 61.8.0 to 62.2.1 HOT 4
- [kube-prometheus-stack] grafana won't display node-exporter metrics on minikube HOT 1
- [kube-prometheus-stack] Missing flexibility support for single/multi cluster alert from kubernetes-mixin
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from helm-charts.