diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d28c0aa..87682ad 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,14 +13,14 @@ Please do not create a Pull Request without creating an issue first. ## What is this change for? -- [ ] Feature / enhancement - *Any change should be discussed in the associated Issue before proceeding. Failure to do so may result in the rejection of the pull request.* +- [ ] Feature / enhancement - _Any change should be discussed in the associated Issue before proceeding. Failure to do so may result in the rejection of the pull request._ - [ ] Bug - [ ] Docs - [ ] Tests ## Description (required) -***Please provide enough information so that others can review your pull request.*** +_**Please provide enough information so that others can review your pull request.**_ Explain the **details** for making this change. What existing problem does the pull request solve and/or what capability does it add? Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. diff --git a/.remarkrc.js b/.remarkrc.js index de6f256..3410a69 100644 --- a/.remarkrc.js +++ b/.remarkrc.js @@ -1,7 +1,7 @@ module.exports = { settings: { bullet: '-', - emphasis: '*', + emphasis: '_', listItemIndent: 'one', quote: "'", rule: '-', @@ -12,11 +12,17 @@ module.exports = { 'remark-preset-lint-consistent', 'remark-preset-lint-markdown-style-guide', 'remark-preset-lint-recommended', + 'remark-preset-prettier', ['remark-lint-list-item-indent', 'space'], ['remark-lint-maximum-line-length', false], ['remark-lint-list-item-spacing', { checkBlanks: true }], ['remark-lint-no-file-name-irregular-characters', false], ['remark-lint-ordered-list-marker-value', 'ordered'], + ['remark-lint-emphasis-marker', '_'], + ['remark-lint-unordered-list-marker-style', '-'], + ['remark-lint-link-title-style', "'"], + ['remark-lint-rule-style', '---'], + ['remark-lint-strong-marker', '*'], 'remark-frontmatter', 'remark-gfm' ] diff --git a/CHANGELOG.md b/CHANGELOG.md index 3619783..c6acb12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -71,7 +71,7 @@ - [Issue 324](https://github.com/jamietre/ImageMapster/issues/324) Improve project health - [Issue 325](https://github.com/jamietre/ImageMapster/issues/325) Add badges & CDN info to readme - [Issue 327](https://github.com/jamietre/ImageMapster/issues/327) Add linter & format files -- [Issue 328](https://github.com/jamietre/ImageMapster/issues/328) Fix tracking internal map\_cache on unbind +- [Issue 328](https://github.com/jamietre/ImageMapster/issues/328) Fix tracking internal map_cache on unbind - [Issue 330](https://github.com/jamietre/ImageMapster/issues/330) Fix shapes example rectangle responds to mouseevents - [Issue 332](https://github.com/jamietre/ImageMapster/issues/332) Fix programmatic area highlight to single area at a time - [Issue 333](https://github.com/jamietre/ImageMapster/issues/333) Fix USA example area highlight & select @@ -254,7 +254,7 @@ Notes - added tests for tooltip external & event bound invocation - added invoking tooltip from area, e.g. $('some-area').mapster('tooltip') - added invoking tooltip from key, e.g. .mapster('tooltip',key); -- Bug fix for get\_options, showToolTip (related) +- Bug fix for get_options, showToolTip (related) - Bug fix - area id 0 on VML rendereding deselection causes all selections to disappear (introduced in beta 2) - Changed "get" to return true "selected" state and not "isSelected()" which includes staticState items in selected. - Bug fix - stroke sometimes rendered improperly when using render-specific options diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54c47f4..f065a5d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ The [issue tracker](https://github.com/jamietre/ImageMapster/issues) is the pref ## Bug reports -A bug is a *demonstrable problem* that is caused by the code in the repository. Good bug reports are extremely helpful, so thank you! +A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful, so thank you! Guidelines for bug reports: diff --git a/README.md b/README.md index 6fae2e0..d4c53ab 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # ImageMapster: A jQuery Plugin to make image maps useful [![license](https://img.shields.io/github/license/jamietre/ImageMapster)](LICENSE) -[![gh stable](https://img.shields.io/github/v/release/jamietre/imagemapster?sort=semver\&label=stable)](https://GitHub.com/jamietre/ImageMapster/releases/) -[![gh latest](https://img.shields.io/github/v/release/jamietre/imagemapster?include_prereleases\&sort=semver\&label=latest)](https://GitHub.com/jamietre/ImageMapster/releases/) +[![gh stable](https://img.shields.io/github/v/release/jamietre/imagemapster?sort=semver&label=stable)](https://GitHub.com/jamietre/ImageMapster/releases/) +[![gh latest](https://img.shields.io/github/v/release/jamietre/imagemapster?include_prereleases&sort=semver&label=latest)](https://GitHub.com/jamietre/ImageMapster/releases/) [![npm downloads](https://img.shields.io/npm/dm/imagemapster?label=npm)](https://www.npmjs.com/package/imagemapster) [![jsDelivr downloads](https://data.jsdelivr.com/v1/package/npm/imagemapster/badge?style=rounded)](https://www.jsdelivr.com/package/npm/imagemapster) [![cdnjs version](https://img.shields.io/cdnjs/v/imagemapster.svg?color=orange)](https://cdnjs.com/libraries/imagemapster) @@ -143,7 +143,7 @@ $('#usamap').mapster('set', true, 'new-england'); $('#usamap').mapster('set', true, 'really-cold'); ``` -Groups created this way are *independent* of the primary group. If you select "new-england" from code, you can't unselect just "MA" by clicking on it. You would have to unselect "new-england" from code. +Groups created this way are _independent_ of the primary group. If you select "new-england" from code, you can't unselect just "MA" by clicking on it. You would have to unselect "new-england" from code. To simply indentify a set of areas to turn on or off, but not treat them as a logical group, you can use CSS classes and select areas directly, or use the `keys` option to identify the primary keys associated with a group (see documentation). diff --git a/package-lock.json b/package-lock.json index 43b1936..0b14a71 100644 --- a/package-lock.json +++ b/package-lock.json @@ -36,7 +36,8 @@ "remark-gfm": "^4.0.0", "remark-preset-lint-consistent": "^5.1.2", "remark-preset-lint-markdown-style-guide": "^5.1.3", - "remark-preset-lint-recommended": "^6.1.3" + "remark-preset-lint-recommended": "^6.1.3", + "remark-preset-prettier": "^2.0.1" }, "peerDependencies": { "jquery": ">=1.7.0" @@ -14283,6 +14284,18 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/remark-preset-prettier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/remark-preset-prettier/-/remark-preset-prettier-2.0.1.tgz", + "integrity": "sha512-1+cZaM080zTlhQIvZDOj7SFWvW9zevfxsLjTZspLEsBYivMDwCyTodvNvaZLc9p5dUSMik/BjMFKicfhZXh7qg==", + "dev": true, + "engines": { + "node": ">=14.8" + }, + "peerDependencies": { + "prettier": ">=1.0.0" + } + }, "node_modules/remark-stringify": { "version": "11.0.0", "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", diff --git a/package.json b/package.json index 02941c7..d822d1f 100644 --- a/package.json +++ b/package.json @@ -79,6 +79,7 @@ "remark-gfm": "^4.0.0", "remark-preset-lint-consistent": "^5.1.2", "remark-preset-lint-markdown-style-guide": "^5.1.3", - "remark-preset-lint-recommended": "^6.1.3" + "remark-preset-lint-recommended": "^6.1.3", + "remark-preset-prettier": "^2.0.1" } }