From 5ac3844a37e68563b997759e9be4c541da59ff97 Mon Sep 17 00:00:00 2001 From: Jamie Mason Date: Fri, 10 Nov 2023 15:46:17 +0000 Subject: [PATCH] style(markdown): format markdown files --- .prettierrc | 9 +----- CODE_OF_CONDUCT.md | 72 ++++++++++++---------------------------------- README.md | 36 +++++++++-------------- site/README.md | 12 +++----- 4 files changed, 38 insertions(+), 91 deletions(-) diff --git a/.prettierrc b/.prettierrc index 877c960e..f525430f 100644 --- a/.prettierrc +++ b/.prettierrc @@ -13,14 +13,7 @@ } }, { - "files": ["**/*.md"], - "options": { - "printWidth": 100, - "proseWrap": "always" - } - }, - { - "files": ["**/*.mdx"], + "files": ["**/*.md", "**/*.mdx"], "options": { "printWidth": 500, "proseWrap": "never" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 10bd9b56..2730ac7c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,14 +2,9 @@ ## Our Pledge -We as members, contributors, and leaders pledge to make participation in our community a -harassment-free experience for everyone, regardless of age, body size, visible or invisible -disability, ethnicity, sex characteristics, gender identity and expression, level of experience, -education, socio-economic status, nationality, personal appearance, race, religion, or sexual -identity and orientation. +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and -healthy community. +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards @@ -18,8 +13,7 @@ Examples of behavior that contributes to a positive environment for our communit - Demonstrating empathy and kindness toward other people - Being respectful of differing opinions, viewpoints, and experiences - Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the - experience +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience - Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: @@ -27,87 +21,59 @@ Examples of unacceptable behavior include: - The use of sexualized language or imagery, and sexual attention or advances of any kind - Trolling, insulting or derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or email address, without their - explicit permission +- Publishing others' private information, such as a physical or email address, without their explicit permission - Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities -Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior -and will take appropriate and fair corrective action in response to any behavior that they deem -inappropriate, threatening, offensive, or harmful. +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. -Community leaders have the right and responsibility to remove, edit, or reject comments, commits, -code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and -will communicate reasons for moderation decisions when appropriate. +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope -This Code of Conduct applies within all community spaces, and also applies when an individual is -officially representing the community in public spaces. Examples of representing our community -include using an official e-mail address, posting via an official social media account, or acting as -an appointed representative at an online or offline event. +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community -leaders responsible for enforcement at jamie@foldleft.io. All complaints will be reviewed and -investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jamie@foldleft.io. All complaints will be reviewed and investigated promptly and fairly. -All community leaders are obligated to respect the privacy and security of the reporter of any -incident. +All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines -Community leaders will follow these Community Impact Guidelines in determining the consequences for -any action they deem in violation of this Code of Conduct: +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction -**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or -unwelcome in the community. +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. -**Consequence**: A private, written warning from community leaders, providing clarity around the -nature of the violation and an explanation of why the behavior was inappropriate. A public apology -may be requested. +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. -**Consequence**: A warning with consequences for continued behavior. No interaction with the people -involved, including unsolicited interaction with those enforcing the Code of Conduct, for a -specified period of time. This includes avoiding interactions in community spaces as well as -external channels like social media. Violating these terms may lead to a temporary or permanent ban. +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban -**Community Impact**: A serious violation of community standards, including sustained inappropriate -behavior. +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. -**Consequence**: A temporary ban from any sort of interaction or public communication with the -community for a specified period of time. No public or private interaction with the people involved, -including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this -period. Violating these terms may lead to a permanent ban. +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban -**Community Impact**: Demonstrating a pattern of violation of community standards, including -sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement -of classes of individuals. +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/README.md b/README.md index d57d99bb..286375d9 100644 --- a/README.md +++ b/README.md @@ -8,38 +8,34 @@ npm install --save-dev syncpack ``` + + +> [!NOTE] +> syncpack 🚀 [12.0.0-alpha.0](https://github.com/JamieMason/syncpack/releases/tag/12.0.0-alpha.0) is available to trial and give feedback. This release adds support for a much wider range of npm version specifiers than before, console output improvements, and more. + + + ## Documentation Full information can be found in the documentation at https://jamiemason.github.io/syncpack/. ## Commands -> [!NOTE] syncpack 🚀 -> [12.0.0-alpha.0](https://github.com/JamieMason/syncpack/releases/tag/12.0.0-alpha.0) is available -> to trial and give feedback. This release adds support for a much wider range of npm version -> specifiers than before, console output improvements, and more. - ### [fix-mismatches](https://jamiemason.github.io/syncpack/fix-mismatches) -Ensure that multiple packages requiring the same dependency define the same version, so that every -package requires eg. `react@16.4.2`, instead of a combination of `react@16.4.2`, `react@0.15.9`, and -`react@16.0.0`. +Ensure that multiple packages requiring the same dependency define the same version, so that every package requires eg. `react@16.4.2`, instead of a combination of `react@16.4.2`, `react@0.15.9`, and `react@16.0.0`. ### [format](https://jamiemason.github.io/syncpack/format) -Organise package.json files according to a conventional format, where fields appear in a predictable -order and nested fields are ordered alphabetically. Shorthand properties are used where available, -such as the `"repository"` and `"bugs"` fields. +Organise package.json files according to a conventional format, where fields appear in a predictable order and nested fields are ordered alphabetically. Shorthand properties are used where available, such as the `"repository"` and `"bugs"` fields. ### [lint](https://jamiemason.github.io/syncpack/lint) -Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack -configuration file. +Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack configuration file. ### [lint-semver-ranges](https://jamiemason.github.io/syncpack/lint-semver-ranges) -Check whether dependency versions used within "dependencies", "devDependencies", etc follow a -consistent format. +Check whether dependency versions used within "dependencies", "devDependencies", etc follow a consistent format. ### [list](https://jamiemason.github.io/syncpack/list) @@ -47,8 +43,7 @@ List all dependencies required by your packages. ### [list-mismatches](https://jamiemason.github.io/syncpack/list-mismatches) -List dependencies which are required by multiple packages, where the version is not the same across -every package. +List dependencies which are required by multiple packages, where the version is not the same across every package. ### [prompt](https://jamiemason.github.io/syncpack/prompt) @@ -56,14 +51,11 @@ Displays a series of prompts to fix mismatches which syncpack cannot fix automat ### [set-semver-ranges](https://jamiemason.github.io/syncpack/set-semver-ranges) -Ensure dependency versions used within `"dependencies"`, `"devDependencies"` etc follow a consistent -format. +Ensure dependency versions used within `"dependencies"`, `"devDependencies"` etc follow a consistent format. ### [update](https://jamiemason.github.io/syncpack/update) -Interactively update packages to the latest versions from the npm registry, wherever they are in -your monorepo. You can update every dependency, just dev/peer/prod dependencies, just packages which -match a name filter, and more. +Interactively update packages to the latest versions from the npm registry, wherever they are in your monorepo. You can update every dependency, just dev/peer/prod dependencies, just packages which match a name filter, and more. ## Badges diff --git a/site/README.md b/site/README.md index fe034258..aaba2fa1 100644 --- a/site/README.md +++ b/site/README.md @@ -1,7 +1,6 @@ # Website -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website -generator. +This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. ### Installation @@ -15,8 +14,7 @@ $ yarn $ yarn start ``` -This command starts a local development server and opens up a browser window. Most changes are -reflected live without having to restart the server. +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. ### Build @@ -24,8 +22,7 @@ reflected live without having to restart the server. $ yarn build ``` -This command generates static content into the `build` directory and can be served using any static -contents hosting service. +This command generates static content into the `build` directory and can be served using any static contents hosting service. ### Deployment @@ -41,5 +38,4 @@ Not using SSH: $ GIT_USER= yarn deploy ``` -If you are using GitHub pages for hosting, this command is a convenient way to build the website and -push to the `gh-pages` branch. +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.