Skip to content

Add support for customSyntax with function export #8834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jeddy3 merged 9 commits into from
Nov 13, 2025
Merged

Add support for customSyntax with function export #8834

jeddy3 merged 9 commits into from
Nov 13, 2025

Conversation

@silverwind
Copy link
Contributor

@silverwind silverwind commented Nov 8, 2025 •
edited
Loading

Which issue, if any, is this issue related to?

Closes #8833

Is there anything in the PR that needs further explanation?

Typescript types are already correct because type interface matches function.

@changeset-bot
Copy link

changeset-bot bot commented Nov 8, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 5b90cc0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
stylelint Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

ryo-manba
ryo-manba reviewed Nov 9, 2025
View reviewed changes
Copy link
Member

@ryo-manba ryo-manba left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could update the docs here:
https://github.com/stylelint/stylelint/blob/main/docs/user-guide/options.md?plain=1#L93

Or maybe updating the PostCSS docs would be better? 🤔
https://postcss.org/docs/how-to-write-custom-syntax#syntax

@silverwind
Copy link
Contributor Author

silverwind commented Nov 9, 2025 •
edited
Loading

I think essentially postcss-html is in violation of the postcss plugin spec, but I guess depending on definition, a function is also an object in JS because it has properties. I will update the docs.

@romainmenke
Copy link
Member

romainmenke commented Nov 9, 2025

I am unsure of we should update the documentation and error message.
As noted postcss-html isn't strictly following the PostCSS API while at the same time any function is also an object in JavaScript.

I think it would be fine to only change this line:

if (typeof customSyntax === 'object' || typeof customSyntax === 'function') {

Then Stylelint is a bit more graceful in what it accepts but without promoting further proliferation of this pattern that goes outside the documented PostCSS API.

silverwind
silverwind commented Nov 10, 2025
View reviewed changes
silverwind
silverwind commented Nov 10, 2025
View reviewed changes
@silverwind
Copy link
Contributor Author

silverwind commented Nov 10, 2025

Okay, changeset is minimal now, just the typeof change and the test.

ryo-manba
ryo-manba approved these changes Nov 10, 2025
View reviewed changes
Copy link
Member

@ryo-manba ryo-manba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@silverwind
Copy link
Contributor Author

silverwind commented Nov 10, 2025

BTW I guess the reason why it worked when passing string to customSyntax must be because the code that loads the npm module must not be doing the same valdiation that is done when a object-like is passed. I guess ideally those code paths should be unified to perform the same validation.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 10, 2025 •
edited
Loading

This PR is packaged and the instant preview is available (5b90cc0). View the demo website.

Install it locally:

npm i -D https://pkg.pr.new/stylelint@5b90cc0

@ryo-manba
Copy link
Member

ryo-manba commented Nov 10, 2025

@silverwind
Can you add lib/getPostcssResult.cjs?

@silverwind
Copy link
Contributor Author

silverwind commented Nov 10, 2025

Done, sorry I forgot this repo had generated files checked into source control.

jeddy3
jeddy3 reviewed Nov 10, 2025
View reviewed changes
@jeddy3 jeddy3 changed the title Support customSyntax with function export Add support for customSyntax with function export Nov 10, 2025
@jeddy3 jeddy3 mentioned this pull request Nov 10, 2025
Closed
4 tasks
romainmenke
romainmenke approved these changes Nov 12, 2025
View reviewed changes
Copy link
Member

@romainmenke romainmenke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. LGTM 👍

@jeddy3 jeddy3 merged commit 2ba1898 into stylelint:main Nov 13, 2025
17 checks passed
@silverwind silverwind deleted the funccustomstyntax branch November 13, 2025 17:07
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Nov 22, 2025
@renovate
Update dependency stylelint to v16.26.0
361368b 
| datasource | package   | from    | to      |
| ---------- | --------- | ------- | ------- |
| npm        | stylelint | 16.25.0 | 16.26.0 |


## [v16.26.0](https://github.com/stylelint/stylelint/blob/HEAD/CHANGELOG.md#16260---2025-11-21)

It adds 1 feature and fixes 2 bugs.

- Added: support for `customSyntax` with function export ([#8834](stylelint/stylelint#8834)) ([@silverwind](https://github.com/silverwind)).
- Fixed: `custom-property-no-missing-var-function` false positives for style query in `if()` function ([#8813](stylelint/stylelint#8813)) ([@sajdakabir](https://github.com/sajdakabir)).
- Fixed: `media-feature-range-notation` false positives for multiple queries and `except: exact-value` ([#8832](stylelint/stylelint#8832)) ([@jeddy3](https://github.com/jeddy3)).
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Nov 22, 2025
@renovate
Update dependency stylelint to v16.26.0
d11547d 
| datasource | package   | from    | to      |
| ---------- | --------- | ------- | ------- |
| npm        | stylelint | 16.25.0 | 16.26.0 |


## [v16.26.0](https://github.com/stylelint/stylelint/blob/HEAD/CHANGELOG.md#16260---2025-11-21)

It adds 1 feature and fixes 2 bugs.

- Added: support for `customSyntax` with function export ([#8834](stylelint/stylelint#8834)) ([@silverwind](https://github.com/silverwind)).
- Fixed: `custom-property-no-missing-var-function` false positives for style query in `if()` function ([#8813](stylelint/stylelint#8813)) ([@sajdakabir](https://github.com/sajdakabir)).
- Fixed: `media-feature-range-notation` false positives for multiple queries and `except: exact-value` ([#8832](stylelint/stylelint#8832)) ([@jeddy3](https://github.com/jeddy3)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeddy3 jeddy3 jeddy3 approved these changes

@romainmenke romainmenke romainmenke approved these changes

@ryo-manba ryo-manba ryo-manba approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add support for customSyntax as function type

4 participants

@silverwind @romainmenke @ryo-manba @jeddy3