diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ae61060c55d5..8db621e66c1d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -16,6 +16,7 @@ body: - builders - collection - core + - formatters - proxy - proxy-container - rest diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 18a68be14906..b84547020408 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -18,6 +18,7 @@ body: - builders - collection - core + - formatters - proxy - proxy-container - rest diff --git a/.github/labeler.yml b/.github/labeler.yml index ab330a867a91..7113d0c12ae1 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -22,6 +22,9 @@ packages:discord.js: packages:docgen: - packages/docgen/* - packages/docgen/**/* +packages:formatters: + - packages/formatters/* + - packages/formatters/**/* packages:proxy: - packages/proxy/* - packages/proxy/**/* diff --git a/.github/labels.yml b/.github/labels.yml index 93a8b938eed1..02bfd8513752 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -62,6 +62,8 @@ color: fbca04 - name: packages:docgen color: fbca04 +- name: packages:formatters + color: fbca04 - name: packages:proxy color: fbca04 - name: packages:proxy-container diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4cda34945244..a9cca60eee77 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -67,7 +67,7 @@ jobs: max-parallel: 1 fail-fast: false matrix: - package: ['brokers', 'builders', 'collection', 'core', 'discord.js', 'proxy', 'rest', 'util', 'voice', 'ws'] + package: ['brokers', 'builders', 'collection', 'core', 'discord.js', 'formatters', 'proxy', 'rest', 'util', 'voice', 'ws'] runs-on: ubuntu-latest env: TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} diff --git a/.github/workflows/npm-auto-deprecate.yml b/.github/workflows/npm-auto-deprecate.yml index d7c7b8340aaf..b087e1f0c32e 100644 --- a/.github/workflows/npm-auto-deprecate.yml +++ b/.github/workflows/npm-auto-deprecate.yml @@ -21,6 +21,6 @@ jobs: uses: ./packages/actions/src/yarnCache - name: Deprecate versions - run: 'yarn npm-deprecate --name "*dev*" --package @discordjs/brokers @discordjs/builders @discordjs/collection @discordjs/core discord.js @discordjs/proxy @discordjs/rest @discordjs/util @discordjs/voice @discordjs/ws' + run: 'yarn npm-deprecate --name "*dev*" --package @discordjs/brokers @discordjs/builders @discordjs/collection @discordjs/core @discordjs/formatters discord.js @discordjs/proxy @discordjs/rest @discordjs/util @discordjs/voice @discordjs/ws' env: NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} diff --git a/.github/workflows/publish-dev.yml b/.github/workflows/publish-dev.yml index bb51ce0c0ad6..2fd3a22230da 100644 --- a/.github/workflows/publish-dev.yml +++ b/.github/workflows/publish-dev.yml @@ -18,6 +18,8 @@ jobs: folder: 'collection' - package: '@discordjs/core' folder: 'core' + - package: '@discordjs/formatters' + folder: 'formatters' - package: 'discord.js' folder: 'discord.js' - package: '@discordjs/proxy' diff --git a/apps/website/src/util/constants.ts b/apps/website/src/util/constants.ts index d662a7ec7845..f44168b965b3 100644 --- a/apps/website/src/util/constants.ts +++ b/apps/website/src/util/constants.ts @@ -1,4 +1,15 @@ -export const PACKAGES = ['brokers', 'builders', 'collection', 'core', 'proxy', 'rest', 'util', 'voice', 'ws']; +export const PACKAGES = [ + 'brokers', + 'builders', + 'collection', + 'core', + 'formatters', + 'proxy', + 'rest', + 'util', + 'voice', + 'ws', +]; export const DESCRIPTION = "discord.js is a powerful node.js module that allows you to interact with the Discord API very easily. It takes a much more object-oriented approach than most other JS Discord libraries, making your bot's code significantly tidier and easier to comprehend."; diff --git a/packages/builders/package.json b/packages/builders/package.json index 8d7319f80b05..934db2a0609c 100644 --- a/packages/builders/package.json +++ b/packages/builders/package.json @@ -54,6 +54,7 @@ }, "homepage": "https://discord.js.org", "dependencies": { + "@discordjs/formatters": "workspace:^", "@discordjs/util": "workspace:^", "@sapphire/shapeshift": "^3.7.1", "discord-api-types": "^0.37.20", diff --git a/packages/builders/src/index.ts b/packages/builders/src/index.ts index 9f644d5b064c..f7d24e571ef4 100644 --- a/packages/builders/src/index.ts +++ b/packages/builders/src/index.ts @@ -1,6 +1,7 @@ export * as EmbedAssertions from './messages/embed/Assertions.js'; export * from './messages/embed/Embed.js'; -export * from './messages/formatters.js'; +// TODO: Consider removing this dep in the next major version +export * from '@discordjs/formatters'; export * as ComponentAssertions from './components/Assertions.js'; export * from './components/ActionRow.js'; diff --git a/packages/formatters/.cliff-jumperrc.json b/packages/formatters/.cliff-jumperrc.json new file mode 100644 index 000000000000..3f2cbd07934f --- /dev/null +++ b/packages/formatters/.cliff-jumperrc.json @@ -0,0 +1,5 @@ +{ + "name": "formatters", + "org": "discordjs", + "packagePath": "packages/formatters" +} diff --git a/packages/formatters/.eslintrc.json b/packages/formatters/.eslintrc.json new file mode 100644 index 000000000000..99ef7cec8051 --- /dev/null +++ b/packages/formatters/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "../../.eslintrc.json" +} diff --git a/packages/formatters/.gitignore b/packages/formatters/.gitignore new file mode 100644 index 000000000000..86b93e929ae6 --- /dev/null +++ b/packages/formatters/.gitignore @@ -0,0 +1,27 @@ +# Packages +node_modules/ + +# Log files +logs/ +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Env +.env + +# Dist +dist/ +typings/ +docs/**/* +!docs/index.json +!docs/README.md + +# Miscellaneous +.tmp/ +coverage/ +tsconfig.tsbuildinfo diff --git a/packages/formatters/.lintstagedrc.js b/packages/formatters/.lintstagedrc.js new file mode 100644 index 000000000000..dc17706a55ac --- /dev/null +++ b/packages/formatters/.lintstagedrc.js @@ -0,0 +1 @@ +module.exports = require('../../.lintstagedrc.json'); diff --git a/packages/formatters/.prettierignore b/packages/formatters/.prettierignore new file mode 100644 index 000000000000..553e0ea6c783 --- /dev/null +++ b/packages/formatters/.prettierignore @@ -0,0 +1,8 @@ +# Autogenerated +CHANGELOG.md +.turbo +dist/ +docs/**/* +!docs/index.yml +!docs/README.md +coverage/ diff --git a/packages/formatters/.prettierrc.js b/packages/formatters/.prettierrc.js new file mode 100644 index 000000000000..f004026c7647 --- /dev/null +++ b/packages/formatters/.prettierrc.js @@ -0,0 +1 @@ +module.exports = require('../../.prettierrc.json'); diff --git a/packages/formatters/LICENSE b/packages/formatters/LICENSE new file mode 100644 index 000000000000..e2baac17a44a --- /dev/null +++ b/packages/formatters/LICENSE @@ -0,0 +1,191 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2021 Noel Buechler + Copyright 2021 Vlad Frangu + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/formatters/README.md b/packages/formatters/README.md new file mode 100644 index 000000000000..418d1da3c93d --- /dev/null +++ b/packages/formatters/README.md @@ -0,0 +1,80 @@ +
+
+

+ discord.js +

+
+

+ Discord server + npm version + npm downloads + Build status + Code coverage +

+

+ Vercel +

+
+ +## About + +`@discordjs/formatters` set of functions to format strings for Discord. + +## Installation + +**Node.js 16.9.0 or newer is required.** + +```sh-session +npm install @discordjs/formatters +yarn add @discordjs/formatters +pnpm add @discordjs/formatters +``` + +## Example usage + +````ts +import { codeBlock } from '@discordjs/formatters'; + +const formattedCode = codeBlock('hello world!'); +console.log(formattedCode); + +// Prints: +// ``` +// hello world! +// ``` +```` + +## Links + +- [Website][website] ([source][website-source]) +- [Documentation][documentation] +- [Guide][guide] ([source][guide-source]) + See also the [Update Guide][guide-update], including updated and removed items in the library. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] + +## Contributing + +Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the +[documentation][documentation]. +See [the contribution guide][contributing] if you'd like to submit a PR. + +## Help + +If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord]. + +[website]: https://discord.js.org/ +[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website +[documentation]: https://discord.js.org/ +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/formatters +[npm]: https://www.npmjs.com/package/@discordjs/formatters +[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/builders/__tests__/messages/formatters.test.ts b/packages/formatters/__tests__/formatters.test.ts similarity index 99% rename from packages/builders/__tests__/messages/formatters.test.ts rename to packages/formatters/__tests__/formatters.test.ts index 6624ff11f8ce..beb136907f1f 100644 --- a/packages/builders/__tests__/messages/formatters.test.ts +++ b/packages/formatters/__tests__/formatters.test.ts @@ -23,7 +23,7 @@ import { TimestampStyles, underscore, userMention, -} from '../../src/index.js'; +} from '../src/index.js'; describe('Message formatters', () => { describe('codeBlock', () => { diff --git a/packages/formatters/api-extractor.json b/packages/formatters/api-extractor.json new file mode 100644 index 000000000000..bc73f2cc022e --- /dev/null +++ b/packages/formatters/api-extractor.json @@ -0,0 +1,3 @@ +{ + "extends": "../../api-extractor.json" +} diff --git a/packages/formatters/cliff.toml b/packages/formatters/cliff.toml new file mode 100644 index 000000000000..03662ce62c27 --- /dev/null +++ b/packages/formatters/cliff.toml @@ -0,0 +1,63 @@ +[changelog] +header = """ +# Changelog + +All notable changes to this project will be documented in this file.\n +""" +body = """ +{% if version %}\ + # [{{ version | trim_start_matches(pat="v") }}]\ + {% if previous %}\ + {% if previous.version %}\ + (https://github.com/discordjs/discord.js/compare/{{ previous.version }}...{{ version }})\ + {% else %}\ + (https://github.com/discordjs/discord.js/tree/{{ version }})\ + {% endif %}\ + {% endif %} \ + - ({{ timestamp | date(format="%Y-%m-%d") }}) +{% else %}\ + # [unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ## {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.scope %}\ + **{{commit.scope}}:** \ + {% endif %}\ + {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/discordjs/discord.js/commit/{{ commit.id }}))\ + {% if commit.breaking %}\ + {% for breakingChange in commit.footers %}\ + \n{% raw %} {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\ + {% endfor %}\ + {% endif %}\ + {% endfor %} +{% endfor %}\n +""" +trim = true +footer = "" + +[git] +conventional_commits = true +filter_unconventional = true +commit_parsers = [ + { message = "^feat", group = "Features"}, + { message = "^fix", group = "Bug Fixes"}, + { message = "^docs", group = "Documentation"}, + { message = "^perf", group = "Performance"}, + { message = "^refactor", group = "Refactor"}, + { message = "^typings", group = "Typings"}, + { message = "^types", group = "Typings"}, + { message = ".*deprecated", body = ".*deprecated", group = "Deprecation"}, + { message = "^revert", skip = true}, + { message = "^style", group = "Styling"}, + { message = "^test", group = "Testing"}, + { message = "^chore", skip = true}, + { message = "^ci", skip = true}, + { message = "^build", skip = true}, + { body = ".*security", group = "Security"}, +] +filter_commits = true +tag_pattern = "@discordjs/formatters@[0-9]*" +ignore_tags = "" +date_order = true +sort_commits = "newest" diff --git a/packages/formatters/package.json b/packages/formatters/package.json new file mode 100644 index 000000000000..5f7660e9c210 --- /dev/null +++ b/packages/formatters/package.json @@ -0,0 +1,69 @@ +{ + "name": "@discordjs/formatters", + "version": "0.1.0", + "description": "A set of functions to format strings for Discord.", + "scripts": { + "test": "vitest run", + "build": "tsup", + "lint": "prettier --check . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --format=pretty", + "format": "prettier --write . && cross-env TIMING=1 eslint src __tests__ --ext .mjs,.js,.ts --fix --format=pretty", + "docs": "api-extractor run --local", + "prepack": "yarn build && yarn lint", + "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/formatters/*'", + "release": "cliff-jumper" + }, + "main": "./dist/index.js", + "module": "./dist/index.mjs", + "typings": "./dist/index.d.ts", + "exports": { + "import": "./dist/index.mjs", + "require": "./dist/index.js", + "types": "./dist/index.d.ts" + }, + "directories": { + "lib": "src", + "test": "__tests__" + }, + "files": [ + "dist" + ], + "contributors": [ + "Crawl ", + "SpaceEEC ", + "Vlad Frangu ", + "Aura Román " + ], + "license": "Apache-2.0", + "keywords": [], + "repository": { + "type": "git", + "url": "git+https://github.com/discordjs/discord.js.git" + }, + "bugs": { + "url": "https://github.com/discordjs/discord.js/issues" + }, + "homepage": "https://discord.js.org", + "dependencies": { + "discord-api-types": "^0.37.20" + }, + "devDependencies": { + "@favware/cliff-jumper": "^1.8.8", + "@microsoft/api-extractor": "^7.32.0", + "@types/node": "^16.18.3", + "@vitest/coverage-c8": "^0.25.3", + "cross-env": "^7.0.3", + "eslint": "^8.28.0", + "eslint-config-neon": "^0.1.40", + "eslint-formatter-pretty": "^4.1.0", + "prettier": "^2.8.0", + "tsup": "^6.5.0", + "typescript": "^4.9.3", + "vitest": "^0.25.3" + }, + "engines": { + "node": ">=16.9.0" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/builders/src/messages/formatters.ts b/packages/formatters/src/formatters.ts similarity index 100% rename from packages/builders/src/messages/formatters.ts rename to packages/formatters/src/formatters.ts diff --git a/packages/formatters/src/index.ts b/packages/formatters/src/index.ts new file mode 100644 index 000000000000..8e673d4c162b --- /dev/null +++ b/packages/formatters/src/index.ts @@ -0,0 +1 @@ +export * from './formatters.js'; diff --git a/packages/formatters/tsconfig.eslint.json b/packages/formatters/tsconfig.eslint.json new file mode 100644 index 000000000000..d04d4be3aedc --- /dev/null +++ b/packages/formatters/tsconfig.eslint.json @@ -0,0 +1,20 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "allowJs": true + }, + "include": [ + "**/*.ts", + "**/*.tsx", + "**/*.js", + "**/*.mjs", + "**/*.jsx", + "**/*.test.ts", + "**/*.test.js", + "**/*.test.mjs", + "**/*.spec.ts", + "**/*.spec.js", + "**/*.spec.mjs" + ], + "exclude": [] +} diff --git a/packages/formatters/tsconfig.json b/packages/formatters/tsconfig.json new file mode 100644 index 000000000000..fd8b5e417b9f --- /dev/null +++ b/packages/formatters/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig.json", + "include": ["src/**/*.ts"] +} diff --git a/packages/formatters/tsup.config.js b/packages/formatters/tsup.config.js new file mode 100644 index 000000000000..3d4480d6d4aa --- /dev/null +++ b/packages/formatters/tsup.config.js @@ -0,0 +1,3 @@ +import { createTsupConfig } from '../../tsup.config.js'; + +export default createTsupConfig({}); diff --git a/packages/scripts/src/generateIndex.ts b/packages/scripts/src/generateIndex.ts index 9b7797b61d65..2bc31a1a5848 100644 --- a/packages/scripts/src/generateIndex.ts +++ b/packages/scripts/src/generateIndex.ts @@ -28,7 +28,18 @@ export interface MemberJSON { summary: string | null; } -export const PACKAGES = ['brokers', 'builders', 'collection', 'core', 'proxy', 'rest', 'util', 'voice', 'ws']; +export const PACKAGES = [ + 'brokers', + 'builders', + 'collection', + 'core', + 'formatters', + 'proxy', + 'rest', + 'util', + 'voice', + 'ws', +]; let idx = 0; export function createApiModel(data: any) { diff --git a/yarn.lock b/yarn.lock index 27dd540f3ce7..b0bd93fe2146 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2047,6 +2047,7 @@ __metadata: version: 0.0.0-use.local resolution: "@discordjs/builders@workspace:packages/builders" dependencies: + "@discordjs/formatters": "workspace:^" "@discordjs/util": "workspace:^" "@favware/cliff-jumper": ^1.9.0 "@microsoft/api-extractor": ^7.33.6 @@ -2155,6 +2156,26 @@ __metadata: languageName: unknown linkType: soft +"@discordjs/formatters@workspace:^, @discordjs/formatters@workspace:packages/formatters": + version: 0.0.0-use.local + resolution: "@discordjs/formatters@workspace:packages/formatters" + dependencies: + "@favware/cliff-jumper": ^1.8.8 + "@microsoft/api-extractor": ^7.32.0 + "@types/node": ^16.18.3 + "@vitest/coverage-c8": ^0.25.3 + cross-env: ^7.0.3 + discord-api-types: ^0.37.20 + eslint: ^8.28.0 + eslint-config-neon: ^0.1.40 + eslint-formatter-pretty: ^4.1.0 + prettier: ^2.8.0 + tsup: ^6.5.0 + typescript: ^4.9.3 + vitest: ^0.25.3 + languageName: unknown + linkType: soft + "@discordjs/guide@workspace:apps/guide": version: 0.0.0-use.local resolution: "@discordjs/guide@workspace:apps/guide" @@ -2582,7 +2603,7 @@ __metadata: languageName: node linkType: hard -"@favware/cliff-jumper@npm:^1.9.0": +"@favware/cliff-jumper@npm:^1.8.8, @favware/cliff-jumper@npm:^1.9.0": version: 1.9.0 resolution: "@favware/cliff-jumper@npm:1.9.0" dependencies: @@ -3201,7 +3222,7 @@ __metadata: languageName: node linkType: hard -"@microsoft/api-extractor@npm:^7.33.5, @microsoft/api-extractor@npm:^7.33.6": +"@microsoft/api-extractor@npm:^7.32.0, @microsoft/api-extractor@npm:^7.33.5, @microsoft/api-extractor@npm:^7.33.6": version: 7.33.6 resolution: "@microsoft/api-extractor@npm:7.33.6" dependencies: @@ -4455,6 +4476,13 @@ __metadata: languageName: node linkType: hard +"@types/node@npm:^16.18.3": + version: 16.18.3 + resolution: "@types/node@npm:16.18.3" + checksum: 6b8ba2ea5d842f7986e366cb9184c54d273d492784dc62e08fd5afeae938d9b61aec6e4222d2541cd18f9b1412ba361bbcb3f4204fb003608af80a2a6af959f9 + languageName: node + linkType: hard + "@types/node@npm:^8.0.0": version: 8.10.66 resolution: "@types/node@npm:8.10.66"