From bb2640ca612d1c6faa1151bbccd014827c793ba7 Mon Sep 17 00:00:00 2001 From: Patrick Kollitsch Date: Fri, 7 May 2021 19:24:16 +0700 Subject: [PATCH] chore: cleanup due to deprecation --- .commitlintrc.js | 5 - .eslintrc | 12 -- .github/dependabot.yml | 24 --- .gitignore | 367 -------------------------------- .npmignore | 11 - .remarkrc.js | 2 - .remarkrc.template | 6 - .stylelintrc.json | 3 - .textlintrc.js | 2 - .versionrc.js | 2 - LICENSE.md | 9 - README.md | 45 +--- SECURITY.md | 5 - bin/release-hook-postrelease.sh | 4 - bin/release-hook-prerelease.sh | 1 - index.js | 17 -- package.json | 54 ----- 17 files changed, 2 insertions(+), 567 deletions(-) delete mode 100644 .commitlintrc.js delete mode 100644 .eslintrc delete mode 100644 .github/dependabot.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .remarkrc.js delete mode 100644 .remarkrc.template delete mode 100644 .stylelintrc.json delete mode 100644 .textlintrc.js delete mode 100644 .versionrc.js delete mode 100644 LICENSE.md delete mode 100644 SECURITY.md delete mode 100755 bin/release-hook-postrelease.sh delete mode 100755 bin/release-hook-prerelease.sh delete mode 100644 index.js delete mode 100644 package.json diff --git a/.commitlintrc.js b/.commitlintrc.js deleted file mode 100644 index 5146d7c..0000000 --- a/.commitlintrc.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = { - "extends": [ - "@dnb-hugo/commitlint-config" - ] -}; diff --git a/.eslintrc b/.eslintrc deleted file mode 100644 index 2813f9d..0000000 --- a/.eslintrc +++ /dev/null @@ -1,12 +0,0 @@ -{ - "extends": [ - "airbnb-base", - "prettier" - ], - "plugins": [ - "prettier" - ], - "rules": { - "prettier/prettier": "error" - } -} diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 244f7a5..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,24 +0,0 @@ -################################################################################ -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates -################################################################################ -version: 2 -updates: - - # managing dependencies for node/npm - - package-ecosystem: "npm" - directory: "/" - schedule: - interval: "daily" - time: "18:00" - timezone: "Asia/Bangkok" - allow: - - dependency-type: "all" - assignees: - - "davidsneighbour" - reviewers: - - "davidsneighbour" - target-branch: "main" - open-pull-requests-limit: 999 - pull-request-branch-name: - separator: "/" - diff --git a/.gitignore b/.gitignore deleted file mode 100644 index c4c3164..0000000 --- a/.gitignore +++ /dev/null @@ -1,367 +0,0 @@ -package-lock.json - -# Created by https://www.toptal.com/developers/gitignore/api/go,node,hugo,webstorm,phpstorm,sublimetext -# Edit at https://www.toptal.com/developers/gitignore?templates=go,node,hugo,webstorm,phpstorm,sublimetext - -### Go ### -# Binaries for programs and plugins -*.exe -*.exe~ -*.dll -*.so -*.dylib - -# Test binary, built with `go test -c` -*.test - -# Output of the go coverage tool, specifically when used with LiteIDE -*.out - -# Dependency directories (remove the comment below to include it) -# vendor/ - -### Go Patch ### -/vendor/ -/Godeps/ - -### Hugo ### -# Generated files by hugo -/public/ -/resources/_gen/ -hugo_stats.json - -# Executable may be added to repository -hugo.exe -hugo.darwin -hugo.linux - -### Node ### -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -lerna-debug.log* - -# Diagnostic reports (https://nodejs.org/api/report.html) -report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage -*.lcov - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (https://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# TypeScript v1 declaration files -typings/ - -# TypeScript cache -*.tsbuildinfo - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Optional stylelint cache -.stylelintcache - -# Microbundle cache -.rpt2_cache/ -.rts2_cache_cjs/ -.rts2_cache_es/ -.rts2_cache_umd/ - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env -.env.test -.env*.local - -# parcel-bundler cache (https://parceljs.org/) -.cache -.parcel-cache - -# Next.js build output -.next - -# Nuxt.js build / generate output -.nuxt -dist - -# Storybook build outputs -.out -.storybook-out -storybook-static - -# rollup.js default build output -dist/ - -# Gatsby files -.cache/ -# Comment in the public line in if your project uses Gatsby and not Next.js -# https://nextjs.org/blog/next-9-1#public-directory-support -# public - -# vuepress build output -.vuepress/dist - -# Serverless directories -.serverless/ - -# FuseBox cache -.fusebox/ - -# DynamoDB Local files -.dynamodb/ - -# TernJS port file -.tern-port - -# Stores VSCode versions used for testing VSCode extensions -.vscode-test - -# Temporary folders -tmp/ -temp/ - -### PhpStorm ### -# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider -# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 - -# User-specific stuff -.idea/**/workspace.xml -.idea/**/tasks.xml -.idea/**/usage.statistics.xml -.idea/**/dictionaries -.idea/**/shelf - -# Generated files -.idea/**/contentModel.xml - -# Sensitive or high-churn files -.idea/**/dataSources/ -.idea/**/dataSources.ids -.idea/**/dataSources.local.xml -.idea/**/sqlDataSources.xml -.idea/**/dynamic.xml -.idea/**/uiDesigner.xml -.idea/**/dbnavigator.xml - -# Gradle -.idea/**/gradle.xml -.idea/**/libraries - -# Gradle and Maven with auto-import -# When using Gradle or Maven with auto-import, you should exclude module files, -# since they will be recreated, and may cause churn. Uncomment if using -# auto-import. -# .idea/artifacts -# .idea/compiler.xml -# .idea/jarRepositories.xml -# .idea/modules.xml -# .idea/*.iml -# .idea/modules -# *.iml -# *.ipr - -# CMake -cmake-build-*/ - -# Mongo Explorer plugin -.idea/**/mongoSettings.xml - -# File-based project format -*.iws - -# IntelliJ -out/ - -# mpeltonen/sbt-idea plugin -.idea_modules/ - -# JIRA plugin -atlassian-ide-plugin.xml - -# Cursive Clojure plugin -.idea/replstate.xml - -# Crashlytics plugin (for Android Studio and IntelliJ) -com_crashlytics_export_strings.xml -crashlytics.properties -crashlytics-build.properties -fabric.properties - -# Editor-based Rest Client -.idea/httpRequests - -# Android studio 3.1+ serialized cache file -.idea/caches/build_file_checksums.ser - -### PhpStorm Patch ### -# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 - -# *.iml -# modules.xml -# .idea/misc.xml -# *.ipr - -# Sonarlint plugin -# https://plugins.jetbrains.com/plugin/7973-sonarlint -.idea/**/sonarlint/ - -# SonarQube Plugin -# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin -.idea/**/sonarIssues.xml - -# Markdown Navigator plugin -# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced -.idea/**/markdown-navigator.xml -.idea/**/markdown-navigator-enh.xml -.idea/**/markdown-navigator/ - -# Cache file creation bug -# See https://youtrack.jetbrains.com/issue/JBR-2257 -.idea/$CACHE_FILE$ - -# CodeStream plugin -# https://plugins.jetbrains.com/plugin/12206-codestream -.idea/codestream.xml - -### SublimeText ### -# Cache files for Sublime Text -*.tmlanguage.cache -*.tmPreferences.cache -*.stTheme.cache - -# Workspace files are user-specific -*.sublime-workspace - -# Project files should be checked into the repository, unless a significant -# proportion of contributors will probably not be using Sublime Text -# *.sublime-project - -# SFTP configuration file -sftp-config.json - -# Package control specific files -Package Control.last-run -Package Control.ca-list -Package Control.ca-bundle -Package Control.system-ca-bundle -Package Control.cache/ -Package Control.ca-certs/ -Package Control.merged-ca-bundle -Package Control.user-ca-bundle -oscrypto-ca-bundle.crt -bh_unicode_properties.cache - -# Sublime-github package stores a github token in this file -# https://packagecontrol.io/packages/sublime-github -GitHub.sublime-settings - -### WebStorm ### -# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider -# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 - -# User-specific stuff - -# Generated files - -# Sensitive or high-churn files - -# Gradle - -# Gradle and Maven with auto-import -# When using Gradle or Maven with auto-import, you should exclude module files, -# since they will be recreated, and may cause churn. Uncomment if using -# auto-import. -# .idea/artifacts -# .idea/compiler.xml -# .idea/jarRepositories.xml -# .idea/modules.xml -# .idea/*.iml -# .idea/modules -# *.iml -# *.ipr - -# CMake - -# Mongo Explorer plugin - -# File-based project format - -# IntelliJ - -# mpeltonen/sbt-idea plugin - -# JIRA plugin - -# Cursive Clojure plugin - -# Crashlytics plugin (for Android Studio and IntelliJ) - -# Editor-based Rest Client - -# Android studio 3.1+ serialized cache file - -### WebStorm Patch ### -# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 - -# *.iml -# modules.xml -# .idea/misc.xml -# *.ipr - -# Sonarlint plugin -# https://plugins.jetbrains.com/plugin/7973-sonarlint - -# SonarQube Plugin -# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin - -# Markdown Navigator plugin -# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced - -# Cache file creation bug -# See https://youtrack.jetbrains.com/issue/JBR-2257 - -# CodeStream plugin -# https://plugins.jetbrains.com/plugin/12206-codestream - -# End of https://www.toptal.com/developers/gitignore/api/go,node,hugo,webstorm,phpstorm,sublimetext diff --git a/.npmignore b/.npmignore deleted file mode 100644 index 74e5b39..0000000 --- a/.npmignore +++ /dev/null @@ -1,11 +0,0 @@ -.github -bin -.browserslistrc -.editorconfig -.eslintrc -.gitattributes -.gitignore -.stylelintrc.json -.textlintrc.js -.versionrc.js -SECURITY.md diff --git a/.remarkrc.js b/.remarkrc.js deleted file mode 100644 index d9624f7..0000000 --- a/.remarkrc.js +++ /dev/null @@ -1,2 +0,0 @@ -const defaultRemarkConfig = require('./index'); -module.exports = defaultRemarkConfig; diff --git a/.remarkrc.template b/.remarkrc.template deleted file mode 100644 index e515cda..0000000 --- a/.remarkrc.template +++ /dev/null @@ -1,6 +0,0 @@ -{ - "plugins": [ - "@dnb-hugo/remark-config", - ["remark-lint-write-good", false] - ] -} diff --git a/.stylelintrc.json b/.stylelintrc.json deleted file mode 100644 index 101ff2f..0000000 --- a/.stylelintrc.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "@dnb-hugo/stylelint-config" -} diff --git a/.textlintrc.js b/.textlintrc.js deleted file mode 100644 index 4fe2918..0000000 --- a/.textlintrc.js +++ /dev/null @@ -1,2 +0,0 @@ -const defaultTextlintConfig = require("@dnb-hugo/textlint-config"); -module.exports = defaultTextlintConfig; diff --git a/.versionrc.js b/.versionrc.js deleted file mode 100644 index 9a38ca7..0000000 --- a/.versionrc.js +++ /dev/null @@ -1,2 +0,0 @@ -const defaultStandardVersion = require('@dnb-hugo/standard-version-config'); -module.exports = defaultStandardVersion; diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 5c7cfa0..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,9 +0,0 @@ -MIT License - -Copyright (c) 2021 Patrick Kollitsch / David's Neighbour - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index e4b64cb..30bb1fc 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,3 @@ -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/95b94ad281a049e292e8e62da1195e20)](https://www.codacy.com/gh/dnb-hugo/remark-config/dashboard) +## deprecated -## DNB-Hugo / remark-config - -[Remark](https://github.com/remarkjs/remark-lint) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. - -### Notes - -This configuration uses [remark-preset-lint-recommended](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-recommended) with some additions on it's own. - -You probably won't need this ;) - -### Installation - -```shell script -npm install -D dnb-hugo/remark-config -``` - -### Configuration - -Put the following into `.remarkrc` in the root of your project. Remove the `write-good` line if you want to ensure the quality of text. It tends to be overzealous though, so it's deactivated by default. - -```json -{ - "plugins": [ - "@dnb-hugo/remark-config", - ["remark-lint-write-good", false] - ] -} -``` - -### Remark Setup Rules - -### All configuration packages - -| Package | Notes | -|---|---| -| [browserslist-config](https://github.com/dnb-hugo/browserslist-config) | [Browserslist](https://github.com/browserslist/browserslist) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | -| [commitlint-config](https://github.com/dnb-hugo/commitlint-config) | [Commitlint](https://github.com/conventional-changelog/commitlint) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | -| [eslint-config](https://github.com/dnb-hugo/eslint-config) | [ESLint](https://github.com/eslint/eslint) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | -| [remark-config](https://github.com/dnb-hugo/remark-config) | [Remark](https://github.com/remarkjs/remark-lint) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | -| [standard-version-config](https://github.com/dnb-hugo/standard-version-config) | [Standard Version](https://github.com/conventional-changelog/standard-version) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | -| [stylelint-config](https://github.com/dnb-hugo/stylelint-config) | [Stylelint](https://github.com/stylelint/stylelint) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | -| [textlint-config](https://github.com/dnb-hugo/textlint-config) | [Textlint](https://github.com/textlint/textlint) configuration used in [dnb-hugo](https://github.com/dnb-hugo) projects. | +This repository is now part of the [dnb-hugo configurations repository](https://github.com/dnb-hugo/configurations) and is available via `npm install @dnb-hugo/remark-config`. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 8616f68..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -## Security Policy - -### Reporting a Vulnerability - -Please report (suspected) security vulnerabilities to **[security@davids-neighbour.com](mailto:security@davids-neighbour.com)**. You will receive a response from us within 48 hours. If we can confirm the issue, we will release a patch as soon as possible depending on complexity but historically within days. diff --git a/bin/release-hook-postrelease.sh b/bin/release-hook-postrelease.sh deleted file mode 100755 index 7316cb8..0000000 --- a/bin/release-hook-postrelease.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash - -git push --follow-tags origin main -npm publish --access public diff --git a/bin/release-hook-prerelease.sh b/bin/release-hook-prerelease.sh deleted file mode 100755 index a9bf588..0000000 --- a/bin/release-hook-prerelease.sh +++ /dev/null @@ -1 +0,0 @@ -#!/bin/bash diff --git a/index.js b/index.js deleted file mode 100644 index a26181e..0000000 --- a/index.js +++ /dev/null @@ -1,17 +0,0 @@ -"use strict"; - -module.exports.plugins = [ - - require("remark-preset-lint-styleguide"), - require("remark-preset-lint-consistent"), - require("remark-frontmatter"), - [require("remark-lint-linebreak-style"), "unix"], - [require("remark-lint-first-heading-level"), 2], - [require("remark-lint-maximum-line-length"), 1000], - [require("remark-lint-write-good"), "warn", { - "passive": false, - "whitelist": ["read-only"] - }], - [require("remark-lint-no-file-name-irregular-characters"), "\\.a-zA-Z0-9-_"], - -]; diff --git a/package.json b/package.json deleted file mode 100644 index c77eec6..0000000 --- a/package.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "name": "@dnb-hugo/remark-config", - "description": "Remarklint configuration used in dnb-hugo projects.", - "version": "2.0.4", - "author": { - "name": "Patrick Kollitsch", - "email": "patrick@davids-neighbour.com", - "web": "https://davids-neighbour.com" - }, - "bugs": "git+https://github.com/dnb-hugo/remark-config/issues", - "commitlint": { - "extends": [ - "@dnb-hugo/commitlint-config" - ] - }, - "dependencies": { - "remark-cli": "9.0.0", - "remark-frontmatter": "3.0.0", - "remark-lint": "8.0.0", - "remark-lint-linebreak-style": "2.0.1", - "remark-lint-write-good": "1.2.0", - "remark-preset-lint-consistent": "4.0.0", - "remark-preset-lint-styleguide": "1.0.0" - }, - "devDependencies": { - "@dnb-hugo/browserslist-config": "*", - "@dnb-hugo/commitlint-config": "*", - "@dnb-hugo/eslint-config": "*", - "@dnb-hugo/standard-version-config": "*", - "@dnb-hugo/textlint-config": "*", - "standard-version": "9.2.0" - }, - "engines": { - "node": ">=14.0.0", - "npm": ">=6" - }, - "homepage": "git+https://github.com/dnb-hugo/remark-config", - "keywords": [ - "remark", - "remarklint", - "remarklint-config" - ], - "license": "MIT", - "main": "index.js", - "repository": "git+https://github.com/dnb-hugo/remark-config", - "scripts": { - "release": "standard-version --release-as patch -a -t \"v\" && ./bin/release-hook-postrelease.sh", - "release-major": "standard-version --release-as major -a -t \"v\" && ./bin/release-hook-postrelease.sh", - "release-next": "standard-version --release-as minor -a -t \"v\" && ./bin/release-hook-postrelease.sh", - "remark": "remark", - "textlint": "textlint", - "textlint-fix": "textlint --fix" - } -}