Comments (10)
Hey, @NickyMeuleman! This is a great idea! Are you good with me assigning this issue to you?
from showmy.chat.
Please do!
from showmy.chat.
@NickyMeuleman Assigned!
For my two cents' worth, here are two standardizations I'd like to really encourage and why:
- Tabs for indentation: The ability to set your own preference tab width is hugely important for folks with low vision who may, for instance, zoom in a lot and set a small tab width so lines don't run off screen, or set a wide tab width so lines don't blur together.
- Use semicolons: This project already has a few immediately-invoked function expressions, which are some of the few times where semicolons are basically required, so requiring semicolons everywhere ensures we don't break our IIFEs.
Beyond that, here are some of the conventions I've already been using which we maaaay consider adopting for minimal changes, but which I'm not married to:
- Single quotes for strings
- No extra spaces for inline objects and destructuring (so
{beep: 'boop'}
rather than{ beep: 'boop' }
)
from showmy.chat.
TIL IIFE's need semicolons. Thought I was able to be rid of those forever, guess not!
from showmy.chat.
Commenting this here because it's relating to the higher-level issue, and not the specific implementation of the PR.
Should JSDOC comments be linted?
It can make writing those a bit easier.
For example: I have 0 experience with those, so I'd like my editor to go "that's not a valid JSDoc, you need to add ***"
edit: comment for myself so I remember: explore eslint-plugin-jsdoc
from showmy.chat.
Oh, interesting - I hadn't considered linting JSDoc comments, @NickyMeuleman, but I'd be open to it if you feel like it would provide benefits for folks who are new to writing them!
My strongest feeling is that linting should enable folks, not hinder them - so where possible, I prefer linting that serves as a helpful guide, rather than a restrictive tool you have to fight against. This seems like one case where it could be a helpful guide.
from showmy.chat.
Super agree!
I only enabled a thin foundation for rules of linting tools in the PRs.
The rules that are enabled lint against "possible errors", those shouldn't include preferences like always using function brackets or not. (wrote "shouldn't" because I haven't checked them all).
Similar question: HTML linting?
I haven't used it before, but I found HTMLlint, and the rules seem like they fit the "prevent errors" pattern instead of the "enforce preferences" one.
from showmy.chat.
Oooh - every single one of those HTMLint rules seems good. I vote yes, let's add HTMLint to the tooling.
from showmy.chat.
TIL Markdown is inconsisent with hard tabs (which probably why Prettier uses spaces for indentation too).
edit: Aha, it correctly uses tabs inside codeblocks automatically, neat. Automatic formatting of code in markdown!
Thoughts on using a linter for Markdown (like MarkdownLint)? To help catch logical errors (like non-incrementing #
headers by skipping a level)
Apparently there is one rule that should be disabled if used together with prettier.
from showmy.chat.
I'm good with adding a Markdown linter!
from showmy.chat.
Related Issues (20)
- Improve `showCommands` experience in URL builder HOT 1
- [feature request] Add badge to names HOT 8
- Allow themes to style `/announce` messages HOT 1
- [Docs] Homepage should explain what this is and how to use it more clearly
- Bug: long links are causing scrollbars on the default theme HOT 2
- Document available css custom properties available for developers HOT 1
- [feature request]: Hotdog based theme HOT 1
- Allow config for buffering messages
- Create progress bar for fundraisers HOT 3
- [feature request] Elevated message flag? HOT 1
- Automatic dependency updates HOT 1
- Document all stylehooks a theme can use
- Allow users to bring their own styles HOT 7
- Let users customize themes with URL-encoded styles HOT 3
- Create a guide for integrating with OBS
- Provide textual descriptions for themes in the HTML for accessibility HOT 3
- Testing Discord webhook; please disregard. HOT 2
- [Lint] Disable `no-descending-specificity` Stylelint rule HOT 1
- show latest messages causes lockup
- Remove deletion delay when themes don't animate/transition outgoing messages HOT 11
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 showmy.chat.