Skip to content

feat: adds steps and instructions for install and manual publish. pac… #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrialexandrou merged 2 commits into from
Aug 10, 2022
Merged

feat: adds steps and instructions for install and manual publish. pac… #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e5343c
feat: adds steps and instructions for install and manual publish. pac…
andrialexandrou Aug 10, 2022
47a7671
remove project notes; this project is close to good
andrialexandrou Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
"directories": {
"test": "test"
},
"scripts": {
"publish": "npm publish --access public --@github:registry=https://registry.npmjs.org",
"test": "npm run lint && jest",
"lint": "markdownlint **/*.{md,mdx} --ignore node_modules --config .markdownlint.js",
"lint:fix": "npm run lint -- --fix"
},
"dependencies": {
"lodash": "^4.17.15"
},
Expand All @@ -15,11 +21,6 @@
"markdownlint-cli": "^0.32.1",
"@github/markdownlint-github": "file:./."
},
"scripts": {
"test": "npm run lint && jest",
"lint": "markdownlint **/*.{md,mdx} --ignore node_modules --config .markdownlint.js",
"lint:fix": "npm run lint -- --fix"
},
"repository": {
"type": "git",
"url": "git+https://github.com/github/markdownlint-github.git"
Expand Down
33 changes: 8 additions & 25 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,11 @@ For now, see our opinions codified in [index.js](./index.js).
touch .markdownlint.js
```

2. Install packages (during development; will change after package is on the registry)
2. Install packages

- ```bash
npm i -D markdownlint-cli # if updating existing package, check for updates
```

- Add package in the `package.json`.

```json
{
"devDependencies": {
"@github/markdownlint-github": "github/markdownlint-github"
}
}
```

- ```bash
npm install
npm install -D markdownlint-cli # if updating existing package, check for updates
npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org]
```

3. Add/modify your linting script in `package.json`. Modify `--ignore` and other arguments as needed.
Expand Down Expand Up @@ -126,13 +113,9 @@ We use `jest` tests as well, which should be an equally comfortable development

To publish, merge your work to main (after PR process completed).

For now, the repository is installed as a package whose location is the repository uploaded on GitHub. This will change.
Manage version and publish on a new branch, and create a PR to merge these changes into main.

## Project status

We're currently in development on this. The delivery target date is August 15, 2022.

[[Story] [Tooling] Tidy up, publish, and update markdown-lint package #1591](https://github.com/github/accessibility/issues/1591)
[[Epic] Increased Accessibility Linting Coverage #1397](https://github.com/github/accessibility/issues/1397)

Effort initiated during a [markdown linting tooling spike](https://github.com/github/accessibility/issues/1429).
```bash
npm version [major|minor|patch] # alternatively, manage version in package.json
npm run publish
```