schalkneethling / minimalist Goto Github PK

Add base style for form elements:

• label
• input
• textarea
• checkbox
• radio
• select
• fieldset
• legend
• field notes

NOTE: Stay as close to browser native to avoid over use of CSS and JavaScript. For example prefer native select to custom-styled select. Prefer native checkbox to custom-styled checkbox etc.

The CSS is generated from sass and is not used directly by any project so, there is no need to add it to source control.

Our typography is not yet defined in Minimalist. We also need a type scale.

Add our iconography to minimalist

Base styling for lists

• Unordered lists (with nesting)
• Ordered lists  (with nesting)
• Definition lists

We are moving Storybook to mdn-fiori and cleaning up here.

Base style for various metadata added to content on MDN docs pages

• obsolete
• deprecated
• experimental
• non-standard

Once #60 is done and merged I will add the new responsive TOC HTML to reference.html and also merge in the relevant styling.

Add and configure stylelint as well as stylelint-a11y

 There are a few stragglers still hanging around.

Define and codify our base grid.

The reference.html page could be a lot more useful for testing the evolution of Minimalist. For the individual components, we do want to eventually move to something like Storybook but, we still need to figure out how that will fit into our world.

Until then, we gotta bootstrap this thing :)

With that in mind, I am going to clean up the reference.html page to only include "components" that we have actual styling for inside Minimalist.

We need a reset stylesheet :) Instead of normalize(which is great!), I am suggesting that we use a modern alternative:

https://hankchizljaw.com/wrote/a-modern-css-reset/

We currently have some "standard" libraries as part of our stylelint tooling that essentially define our CSS/SCSS coding standards:

file: https://github.com/schalkneethling/mdn-minimalist/blob/efd5b03c0b5f10ac79d55f6c8cf36c7175f5afa2/.stylelintrc.json

"stylelint-config-standard",
"stylelint-config-recommended-scss",
"stylelint-config-sass-guidelines",
"stylelint-a11y/recommended",
"stylelint-prettier/recommended"

That is great, useful and important. The thing I do not like is that we do not necessarily know what is inside those black boxes, and that is not good. It also means people writing code will have to kinda write and wait for the tooling to tell them that they have strayed from the path :)

With that in mind, I am thinking we should take the time to understand these "standards" we are opting into, document the most important parts that can be a little surprising to people*, and ensure we actually want to opt into all of the rules/standards they define. For example, stylelint-config-standard defaults to 1 level of nesting, which we have agreed is too strict and so we add this to our stylelint.json

"rules": {
  "max-nesting-depth": 3
}

My thinking then is for each of us to grab a package and dig in. Does that sound like a plan/something you would be interested in @mindy?

Tasks

Review and document the following packages

• stylelint-config-standard dropped in favor of stylelint-config-recommended
• stylelint-config-recommended-scss
• stylelint-config-sass-guidelines
• stylelint-a11y/recommended
• stylelint-prettier/recommended // not sure that this one will require much if anything, but adding it just to be consistent

*Here I am thinking about stuff like ordering in SCSS files for example, and in general with regards to CSS properties. For example, I really like this pattern:

.class {
  @extend .extend;
  @include mixin();
  property/values...
}

The above might also not be immediately intuitive to everyone. When it comes to property order it might be even more unclear unless documented clearly, even for us in the beginning.

The current :focus and :active styling for radio buttons and checkboxes are not great. We do have an improvement in mind, this issue to implement said improvement.

We have a $base-font-size of 18px and a $tiny-text that is set to 0.75rem;. We need something in between for things such as field notes on forms.

It seems like 16px might be just right. Add the following to sass/vars/_typography.scss

$smaller-font-size: 16px;

After publishing to npm and installing inside mdn-fiori I am noticing there are some filepaths that do not translate well. For example:

{
  "status": 1,
  "file": "/Users/schalkneethling/repos/mdn-fiori/node_modules/mdn-minimalist/sass/components/auth/auth-modal.scss",
  "line": 1,
  "column": 1,
  "message": "File to import not found or unreadable: ../vars/_vars-media-queries.scss.",
  "formatted": "Error: File to import not found or unreadable: ../vars/_vars-media-queries.scss.\n        on line 1 of node_modules/mdn-minimalist/sass/components/auth/auth-modal.scss\n>> @import '../vars/_vars-media-queries.scss';\n\n   ^\n"
}

Will need to resolve these problems or else the package is not useable by other projects.

We currently have two scss files that contain color values. Besides the fact that we do not, and should not, use all of these colors, having them in two places is not ideal.

We also need to get to define a color scheme for MDN and this would be the first step. The next step is to get all the colors visualized using the style guide on MDN-Fiori.

From there we can define the color scheme and cleanup all of the colors with the assistance of Mustafa.

@mindy For the first portion of this I am going to open a PR and merge so that we can publish a new version to use in MDN-Fiori for steps 2 and onward.

I will need your review and assistance with steps 2 onward.

All Mozilla projects need to following CODE_OF_CONDUCT.md:

# Community Participation Guidelines

This repository is governed by Mozilla's code of conduct and etiquette guidelines. 
For more details, please read the
[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). 

## How to Report
For more information on how to report violations of the Community Participation Guidelines, please read our '[How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/)' page.

<!--
## Project Specific Etiquette

In some cases, there will be additional project etiquette i.e.: (https://bugzilla.mozilla.org/page.cgi?id=etiquette.html).
Please update for your project.
-->

We need a .icon class with the following base style

display: inline-block;
content: "";
background-color: transparent;
background-position: 0 0;
background-repeat: no-repeat;
background-size: 21px;
margin-right: 5px;
width: 21px;
height: 21px;
vertical-align: sub;

Now that we have Storybook as part of the repo, we should look at Chromatic for visual regression testing:

https://www.chromatic.com/

Our color palette is missing a set of colors used for statuses such as error, success, and warning. These are defined so, add them to the color palette.

Add the existing styling we have for all the many button styles 😺
From there we need to add a page to our design system so we define our actual button styles.

Deploy a test version of Minimalist to NPM using Github Actions.

There is a couple of utilities that minimalist is currently missing. Some of these are:

• visually-hidden
• reset-visually-hidden
• hidden
• show

We can safely remove stylelint-config-recommended-scss as it does exactly what stylelint-config-recommended does.

The following two classes are missing from our typography definitions:

• tiny-text
• readable-line-length

This fork is now the canonical version of what used to be called mdn-minimalist. It has been renamed to minimalist and we need to remove anything that is MDN or Mozilla specific.

Somehow this bug has slipped into _utils.scss

Is

.visually-hidden {
  @include .visually-hidden();
}

Should Be

.visually-hidden {
  @include visually-hidden();
}

We have way more sass in the repo currently than we need. This is getting in the way, gets old quickly, and stops us from turning on linting.

Time to 🧹

We have stylelint-scss as a dependency but we do not have it configured properly 😸 - Add the following to .stylelintrc

"plugins": [
  "stylelint-scss"
],

Add base style for links

• General
• External links
• mailto links