.github/ISSUE_TEMPLATE/formatting.yml

@@ -13,6 +13,13 @@ body:
       label: printWidth
       description: What value do you have the `printWidth` option set to? (Defaults to `80`.)
       placeholder: "80"
+  - type: input
+    attributes:
+      label: singleAttributePerLine
+      description: What value do you have the `singleAttributePerLine` option set to? (Defaults to `false`.)
+      options:
+        - "true"
+        - "false"
   - type: input
     attributes:
       label: tabWidth
@@ -24,7 +31,8 @@ body:
       description: What value do you have the `xmlWhitespaceSensitivity` option set to? (Defaults to `"strict"`.) Be 100% sure changing this to `"ignore"` doesn't fix your issue!
       options:
         - "strict"
-        - "ignore"
+        - "preserve"
+        - "ignore"        
     validations:
       required: true
   - type: dropdown

.github/dependabot.yml

@@ -4,3 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/auto-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.6.0
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/main.yml

@@ -1,7 +1,9 @@
 name: Main
+
 on:
 - push
-- pull_request_target
+- pull_request
+
 jobs:
   ci:
     name: CI
@@ -10,29 +12,13 @@ jobs:
       CI: true
     steps:
     - uses: actions/checkout@master
-    - uses: actions/setup-node@v2
+    - uses: actions/setup-node@v3
       with:
-        node-version: 14.x
+        node-version: 18.x
         cache: yarn
     - name: Lint and test
       run: |
         yarn install --frozen-lockfile
-        yarn prepublishOnly
         yarn lint
-        yarn prettier --plugin . --check '**/*'
+        yarn prettier --check '**/*'
         yarn test
-
-  automerge:
-    name: AutoMerge
-    needs: ci
-    runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
-    steps:
-    - uses: actions/github-script@v3
-      with:
-        script: |
-          github.pulls.merge({
-            owner: context.payload.repository.owner.login,
-            repo: context.payload.repository.name,
-            pull_number: context.payload.pull_request.number
-          })

.gitignore

@@ -1,5 +1,6 @@
 /.eslintcache
 /coverage/
+/src/languages.js
 /dist/
 /node_modules/
 /test.xml

.prettierignore

@@ -6,6 +6,5 @@
 /yarn.lock
 /LICENSE
 
-/src/types.ts
 /test/fixture.xml
 /test/__snapshots__/*

CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.0.0-alpha.0] - 2023-06-02
+
+### Added
+
+- The `xmlWhitespaceSensitivity: "preserve"` option has been added. See the README.
+
+### Changed
+
+- Fixed the behavior of `bracketSameLine` when the attributes on the parent element broke into multiple lines.
+- **BREAKING** Require prettier v3.
+- **BREAKING** Migrate to ESM modules.
+
 ## [2.2.0] - 2022-05-12
 
 ### Added
@@ -191,7 +203,8 @@ and it will maintain your formatting.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-xml/compare/v2.2.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-xml/compare/v3.0.0-alpha.0...HEAD
+[3.0.0-alpha.0]: https://github.com/prettier/plugin-xml/compare/v2.2.0...v3.0.0-alpha.0
 [2.2.0]: https://github.com/prettier/plugin-xml/compare/v2.1.0...v2.2.0
 [2.1.0]: https://github.com/prettier/plugin-xml/compare/v2.0.1...v2.1.0
 [2.0.1]: https://github.com/prettier/plugin-xml/compare/v2.0.0...v2.0.1

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, sex characteristics, 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
+
+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
+- 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
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at prettier-contact@googlegroups.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 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.
+
+## Attribution
+
+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
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -5,7 +5,7 @@
     <img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
   </a>
   <a href="https://github.com/prettier/plugin-xml/actions">
-    <img alt="GitHub Actions" src="https://img.shields.io/github/workflow/status/prettier/plugin-xml/Main?style=flat-square">
+    <img alt="GitHub Actions" src="https://img.shields.io/github/actions/workflow/status/prettier/plugin-xml/main.yml?branch=main&style=flat-square">
   </a>
   <a href="https://www.npmjs.com/package/@prettier/plugin-xml">
     <img alt="NPM Version" src="https://img.shields.io/npm/v/@prettier/plugin-xml.svg?style=flat-square">
@@ -44,16 +44,16 @@ The `prettier` executable is now installed and ready for use:
 
 ## Configuration
 
-Below are the options (from [`src/plugin.ts`](src/plugin.ts)) that `@prettier/plugin-xml` currently supports:
+Below are the options (from [`src/plugin.js`](src/plugin.js)) that `@prettier/plugin-xml` currently supports:
 
-| API Option                 | CLI Option                     |  Default   | Description                                                                                                   |
-| -------------------------- | ------------------------------ | :--------: | ------------------------------------------------------------------------------------------------------------- |
-| `bracketSameLine`          | `--bracket-same-line`          |   `true`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#bracket-same-line))         |
-| `printWidth`               | `--print-width`                |    `80`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)).              |
-| `singleAttributePerLine`   | `--single-attribute-per-line`  |  `false`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#single-attribute-per-line)) |
-| `tabWidth`                 | `--tab-width`                  |    `2`     | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).                |
-| `xmlSelfClosingSpace`      | `--xml-self-closing-space`     |   `true`   | Adds a space before self-closing tags.                                                                        |
-| `xmlWhitespaceSensitivity` | `--xml-whitespace-sensitivity` | `"strict"` | Options are `"strict"` and `"ignore"`. You may want `"ignore"`, [see below](#whitespace).                     |
+| API Option                 | CLI Option                     |  Default   | Description                                                                                                              |
+| -------------------------- | ------------------------------ | :--------: | ------------------------------------------------------------------------------------------------------------------------ |
+| `bracketSameLine`          | `--bracket-same-line`          |   `true`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#bracket-same-line))                    |
+| `printWidth`               | `--print-width`                |    `80`    | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)).                         |
+| `singleAttributePerLine`   | `--single-attribute-per-line`  |  `false`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#single-attribute-per-line))            |
+| `tabWidth`                 | `--tab-width`                  |    `2`     | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).                           |
+| `xmlSelfClosingSpace`      | `--xml-self-closing-space`     |   `true`   | Adds a space before self-closing tags.                                                                                   |
+| `xmlWhitespaceSensitivity` | `--xml-whitespace-sensitivity` | `"strict"` | Options are `"strict"`, `"preserve"`, and `"ignore"`. You may want `"ignore"` or `"preserve"`, [see below](#whitespace). |
 
 Any of these can be added to your existing [prettier configuration
 file](https://prettier.io/docs/en/configuration.html). For example:
@@ -76,6 +76,8 @@ In XML, by default, all whitespace inside elements has semantic meaning. For pre
 
 If you're sure that the XML files that you're formatting do not require whitespace sensitivity, you can use the `"ignore"` option, as this will produce a standardized amount of whitespace. This will fix any indentation issues, and collapse excess blank lines (max of 1 blank line). For most folks most of the time, this is probably the option that you want.
 
+You can also use the `"preserve"` option, if you want to preserve the whitespace of text nodes within XML elements and attributes. See [#478](https://github.com/prettier/plugin-xml/issues/478) for more detail.
+
 ### Ignore ranges
 
 You can use two special comments to get prettier to ignore formatting a specific piece of the document, as in the following example:

bin/languages.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+import { writeFileSync } from "node:fs";
+import linguistLanguages from "linguist-languages";
+import { format } from "prettier";
+import packageJSON from "../package.json" assert { type: "json" };
+
+function getSupportLanguages() {
+  const supportLanguages = [];
+
+  for (const language of Object.values(linguistLanguages)) {
+    if (language.aceMode === "xml") {
+      const { type, color, aceMode, languageId, ...config } = language;
+
+      // Before we used linguist to get the languages, we had a
+      // manually-maintained list. These two had been added manually. So in the
+      // interest of not breaking anything, we'll add them back in here.
+      if (language.name === "XML") {
+        language.extensions?.push(".inx", ".runsettings");
+        language.extensions?.sort();
+      }
+
+      supportLanguages.push({
+        ...config,
+        since: "0.1.0",
+        parsers: ["xml"],
+        linguistLanguageId: languageId,
+        vscodeLanguageIds: ["xml"]
+      });
+    }
+  }
+
+  return supportLanguages;
+}
+
+const languages = JSON.stringify(getSupportLanguages());
+const { plugins, ...prettierConfig } = packageJSON.prettier;
+
+const formatted = await format(`export default ${languages};`, {
+  parser: "babel",
+  ...prettierConfig
+});
+writeFileSync("src/languages.js", formatted);

bin/print.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+import fs from "fs";
+import { format } from "prettier";
+
+import plugin from "../src/plugin.js";
+
+const code = fs.existsSync(process.argv[2])
+  ? fs.readFileSync(process.argv[2], "utf-8")
+  : process.argv.slice(2).join(" ").replace(/\\n/g, "\n");
+
+const options = {
+  parser: "xml",
+  plugins: [plugin],
+  xmlWhitespaceSensitivity: "ignore",
+  embeddedLanguageFormatting: "auto"
+};
+
+format(code, options).then((formatted) => console.log(formatted));