From 096a255d54474b58b80c659274c4604ed67c9039 Mon Sep 17 00:00:00 2001 From: Monica Date: Fri, 16 Aug 2024 11:53:53 +1000 Subject: [PATCH] Update repository information (#1) --- .atlassian/OWNER | 1 + .github/PULL_REQUEST_TEMPLATE.md | 27 +--- CODE_OF_CONDUCT.md | 78 +++-------- CONTRIBUTING.md | 139 ++----------------- LICENSE | 222 ++++++++++++++++++++++++++++--- packages/core/parcel/README.md | 106 ++++++++------- 6 files changed, 297 insertions(+), 276 deletions(-) create mode 100644 .atlassian/OWNER diff --git a/.atlassian/OWNER b/.atlassian/OWNER new file mode 100644 index 000000000..52254c859 --- /dev/null +++ b/.atlassian/OWNER @@ -0,0 +1 @@ +jbrown2 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 180a94437..aeb89981e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,26 +1,13 @@ - -Search open/closed issues before submitting since someone might have pushed the same thing before! ---> +## Motivation -# β†ͺ️ Pull Request +Provide relevant context and motivation behind the change, if any - +## Changes -## πŸ’» Examples +Describe the solution and changes you have made - +## Checklist -## 🚨 Test instructions - - - -## βœ”οΈ PR Todo - -- [ ] Added/updated unit tests for this change -- [ ] Filled out test instructions (In case there aren't any unit tests) -- [ ] Included links to related issues/PRs +- [ ] Existing or new tests cover this change diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 01dbbfbfc..c048a940b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,73 +1,27 @@ -# Contributor Covenant Code of Conduct +# Contributor Code of Conduct -## Our Pledge +As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -education, socio-economic status, nationality, personal appearance, race, -religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments * Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers 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, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement +* Publishing other's private information, such as physical or electronic addresses, without explicit permission +* Submitting contributions or comments that you know to violate the intellectual property or privacy rights of others +* Other unethical or unprofessional conduct -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at devongovett@gmail.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. +Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. +By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. -## Attribution +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer. Complaints will result in a response and be reviewed and investigated in a way that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/][version] -[homepage]: https://www.contributor-covenant.org +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/3/0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 121713a4d..463176c87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,135 +1,22 @@ -# Contributing +# Contributing to Atlaspack -Welcome, we really appreciate if you're considering to contribute, the joint effort of our contributors make projects like this possible! +Thank you for considering a contribution to Atlaspack! Unfortunately pull requests, issues and comments are not being accepted outside of Atlassian at this time. -The goal of this document is to provide guidance on how you can get involved. +--- -## Asking questions +For pull requests, please: -Have a question or feature request? Rather than opening an issue, use the [Discussions](https://github.com/parcel-bundler/parcel/discussions) board. +* Add tests for new features and bug fixes +* Follow the existing style +* Separate unrelated changes into multiple pull requests -Please be polite and take the time to write a well-worded question so our community members can easily assist you. +See the existing issues for things to start contributing. -## Prerequisites +For bigger changes, please make sure you start a discussion first by creating an issue and explaining the intended change. --> -Before starting make sure you have the following installed: +Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code / documentation / translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership). -- [git](https://git-scm.com) -- [Node](https://nodejs.org) at LTS -- [Yarn](https://yarnpkg.com) at v1 -- [Rust](https://www.rust-lang.org/tools/install) stable -- [Flow](https://flow.org/en/docs/editors) IDE autocompletion and type-checking +Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual. -## Getting started - -In order to make it easier to get familiar with the codebase we labeled simpler issues using [Good First Issue](https://github.com/parcel-bundler/parcel/issues?q=is%3Aopen+is%3Aissue+label%3A%22%E2%9C%A8+Parcel+2%22+label%3A%22%3Ababy%3A+Good+First+Issue%22) and [Help Wanted](https://github.com/parcel-bundler/parcel/issues?q=is%3Aopen+is%3Aissue+label%3A%22%E2%9C%A8+Parcel+2%22+label%3A%22%3Apray%3A+Help+Wanted%22). You can learn the internals by reading the [documentation](https://parceljs.org/docs) or by starting from `packages/core/core/src/Parcel.js` - -## Pull requests - -For significant changes, it is recommended that you first [propose your solution](https://github.com/parcel-bundler/parcel/discussions) and gather feedback. - -**Before submitting a pull request,** you can follow this step by step guide: - -1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository and setup a new branch to work in. - -> It's important that the changes are made in separate branches to ensure a pull request only includes the commits related to a bug or feature. - -2. Run `yarn` and `yarn build-native` in the repository root to install dependencies. -3. If you fix a bug or introduce a new feature, add tests or ask for help if the use-case is more complex. -4. Commit the `yarn.lock` file if it has changed. -5. Check the steps used in [ci](https://github.com/parcel-bundler/parcel/blob/v2/.github/workflows/ci.yml) pass locally. - -```sh -$ yarn build-ts -$ yarn flow check -$ yarn lint -$ yarn test -``` - -⚠️ Don't modify the `package.json` versioning - -Once you are ready to create a pull request, provide relevant details about the change; examples; and test cases. All submissions require review, so please be patient! - -## Development workflow - -The following commands are available: - -- `yarn build-ts` generates the TypeScript type definitions. -- `yarn flow check` runs the [Flow](https://flow.org) type checking. -- `yarn format` keeps the code formatting consistent. -- `yarn lint` checks for stylistic or unwanted errors. -- `yarn test` runs all the unit and integration tests. -- `yarn test:integration` runs the integration tests. -- `yarn test:unit` runs the unit tests. - -### Debugging - -Both VSCode and CLion can be used to debug commands such as the integration test suite. - -- **CLion** is well supported, using default configurations for the relevant language. -- **VSCode** users can use the JavaScript Debug Terminal or Node.js launch configuration to debug JavaScript. Rust debugging requires a [LLDB](https://lldb.llvm.org/) powered launch configuration, which is available by installing the [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) extension. - -**Breakpoints not triggering?** Try passing in `PARCEL_WORKERS=0` to make all code run on the main thread, instead of in worker processes. Similarly, you can set `PARCEL_MAX_CONCURRENT_CALLS` to change the limit of concurrent calls per worker. - -### Plugins - -When developing plugins, you should disable caching with the `--no-cache` CLI or `shouldDisableCache: true` Parcel option. This will ensure you do not see stale or incomplete results. - -### Working from an example - -_Please don't commit these examples._ - -You can create a temporary example for debugging in the folder `packages/examples`. Start by copying the `simple` example and try to reproduce the bug. It has everything setup for working on local changes and you can run `yarn build` to build the project. If you're re-using another example or creating one from scratch, make sure to use the `--no-cache` flag for `parcel build` to see your local changes reflected. - -### Testing outside of the monorepo - -You can run `/path/to/monorepo/packages/core/parcel/src/bin.js build src/index.html` provided that you don't have any `@parcel/*` plugins installed in this project. - -## Releasing a new version - -When releasing a new version of Parcel a couple steps should be followed: - -1. Run `yarn tag:prerelease 2.0.0-alpha.1` or `yarn tag:release 2.4.5` based on whether it is a prerelease (alpha, beta, nightly, ...) or a stable release -2. Open a PR (or commit directly to the default branch) -3. Wait for the PR to get merged -4. Create a [GitHub release](https://github.com/parcel-bundler/parcel/releases) and publish it (this should automatically trigger an npm release, with the current state of the default branch and versions defined in the `package.json` files) - -After these steps are completed there should be a new version of Parcel published on npm. - -In case the automatic npm release failed, or you want to do a manual release for any other reason you can also run `yarn run release` - -## Become a backer or sponsor - -Showing appreciation makes us happy, donations help us grow. - -Our financial situation is fully transparent on our [open collective](https://opencollective.com/parcel). - -Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. - -## Credits - -### Contributors - -Thank you to all the people who have already contributed to parcel! - - -### Backers - -Thank you to all our backers! [[Become a backer](https://opencollective.com/parcel#backer)] - - - -### Sponsors - -Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/parcel#sponsor)) - - - - - - - - - - - +* [CLA for corporate contributors](https://opensource.atlassian.com/corporate) +* [CLA for individuals](https://opensource.atlassian.com/individual) diff --git a/LICENSE b/LICENSE index 7fb9bc953..47cdfcd73 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2017-present Devon Govett - -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. + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (c) 2024 Atlassian US., Inc. + + 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/core/parcel/README.md b/packages/core/parcel/README.md index 208ad0dab..6a6daeaa0 100644 --- a/packages/core/parcel/README.md +++ b/packages/core/parcel/README.md @@ -1,66 +1,78 @@ -

- - Parcel - -

+# Atlaspack -[![Backers on Open Collective](https://opencollective.com/parcel/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/parcel/sponsors/badge.svg)](#sponsors) -[![Build Status](https://dev.azure.com/devongovett/devongovett/_apis/build/status/parcel-bundler.parcel?branchName=v2)](https://dev.azure.com/devongovett/devongovett/_build/latest?definitionId=1) -[![npm package](https://img.shields.io/npm/v/parcel.svg)](https://www.npmjs.com/package/parcel) -[![npm package](https://img.shields.io/npm/dm/parcel.svg)](https://www.npmjs.com/package/parcel) -[![Discord](https://img.shields.io/discord/894288336095690753)](https://discord.gg/XSCzqGRuvr) -[![Twitter Follow](https://img.shields.io/twitter/follow/parceljs.svg?style=social)](https://twitter.com/parceljs) +[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) + -Parcel is a zero configuration build tool for the web. It combines a great out-of-the-box development experience with a scalable architecture that can take your project from just getting started to massive production application. +Atlaspack is the frontend bundler used to build Atlassian products, written in JavaScript and Rust by core contributors of [Parcel](https://github.com/parcel-bundler/parcel). It has been engineered to bundle exceptionally large applications and serve the needs of our products. While you are welcome to try out atlaspack, we do not plan to support use-cases outside of Atlassian at this time. Therefore, we advise against using atlaspack in production environments. -## Features +> [!NOTE] +> This repository is currently a direct fork of [Parcel](https://github.com/parcel-bundler/parcel) that will diverge over time to better handle the needs and scale required by Atlassian -- 😍 **Zero config** – Parcel supports many languages and file types out of the box, from web technologies like HTML, CSS, and JavaScript, to assets like images, fonts, videos, and more. It has a built-in dev server with hot reloading, beautiful error diagnostics, and much more. No configuration needed! -- ⚑️ **Lightning fast** – Parcel's JavaScript compiler is written in Rust for native performance. Your code is built in parallel using worker threads, utilizing all of the cores on your machine. Everything is cached, so you never build the same code twice. It's like using watch mode, but even when you restart Parcel! -- πŸš€ **Automatic production optimization** – Parcel optimizes your whole app for production automatically. This includes tree-shaking and minifying your JavaScript, CSS, and HTML, resizing and optimizing images, content hashing, automatic code splitting, and much more. -- 🎯 **Ship for any target** – Parcel automatically transforms your code for your target environments. From modern and legacy browser support, to zero config JSX and TypeScript compilation, Parcel makes it easy to build for any target – or many! -- 🌍 **Scalable** – Parcel requires zero configuration to get started. But as your application grows and your build requirements become more complex, it's possible to extend Parcel in just about every way. A simple configuration format and powerful plugin system that's designed from the ground up for performance means Parcel can support projects of any size. +Special thanks to [Devon](https://github.com/devongovett) for his invaluable contributions, guidance, and wisdom in shaping the foundations of the Atlassian bundler! -## Getting Started +## Prerequisites -See the following guides in our documentation on how to get started with Parcel. +- [Node](https://nodejs.org) LTS +- [Rust](https://www.rust-lang.org/tools/install) stable toolchain +- [Yarn](https://yarnpkg.com) v1 -* [Building a webapp with Parcel](https://parceljs.org/getting-started/webapp/) -* [Building a library with Parcel](https://parceljs.org/getting-started/library/) -* [Migrating from Parcel v1](https://parceljs.org/getting-started/migration/) +## Installation -## Documentation +```sh +npm install --save-dev atlaspack +``` + +## Usage + +```sh +atlaspack src/index.html +``` + +--- -Read the docs at https://parceljs.org/docs/. +src/index.html +```html + + + + + Atlaspack App + + + +

Hello, World!

+ + +``` + +--- + +src/app.js +```js +console.log('Hello, World!'); +``` + +## Documentation -## Community +Check the [docs website](https://parceljs.org) or the [docs](https://github.com/atlassian-labs/atlaspack/tree/main/docs) folder. -- ❓ Ask questions on [GitHub Discussions](https://github.com/parcel-bundler/parcel/discussions). -- πŸ’¬ Join the community on [Discord](https://discord.gg/XSCzqGRuvr). -- πŸ“£ Stay up to date on new features and announcements on [Twitter](https://twitter.com/parceljs). +## Tests -## Contributors +```sh +yarn test +``` -This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). -contributors +## Contributions -## Backers + -Thank you to all our backers! πŸ™ [[Become a backer](https://opencollective.com/parcel#backer)] +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details. - +## License -## Sponsors +Copyright (c) 2024 Atlassian US., Inc. +Apache 2.0 licensed, see [LICENSE](LICENSE) file. -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/parcel#sponsor)] +
- - - - - - - - - - +[![With ҝ€ï¸ from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-cheers-light.png)](https://www.atlassian.com)