Remove syntax option

[fpetrakov]

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

Closes #6414.

Is there anything in the PR that needs further explanation?

No, it's self-explanatory.

[changeset-bot]

🦋 Changeset detected

Latest commit: 87c9bea

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

This PR includes changesets to release 1 package

Name	Type
stylelint	Major

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

[fpetrakov]

Is it everything I should have done? I guess, no

[fpetrakov]

I will need some help as I haven't worked with these parts of the codebase yet.

[ybiquitous]

@fpetrakov Thanks for working on the issue. This change should be a breaking change, so could you please change the base branch from main to v15 (I've just created it)? See also #6409.

[ybiquitous]

@fpetrakov Let's fix all type errors caused by removing syntax from the LinterOptions type.

Also, we need to remove the code about syntax from cli.js. For example:

stylelint/lib/cli.js

Lines 332 to 335 in e3585ed

	syntax: {
	alias: 's',
	type: 'string',
	},

It also looks like the following code could be removed (there may be more):

stylelint/types/stylelint/index.d.ts

Line 211 in e3585ed

syntax?: string;

[fpetrakov]

@ybiquitous Thanks for the detailed explanation. I will work on this issue ASAP 🚀

[fpetrakov]

stylelint/lib/__tests__/standalone-syntax.test.js

Lines 153 to 183 in e3585ed

	it('rejects on syntax option', async () => {
	await expect(
	standalone({
	syntax: 'scss',
	code: '',
	config: { rules: { 'block-no-empty': true } },
	}),
	).rejects.toThrow(
	'The "syntax" option is no longer available. You should install an appropriate syntax, e.g. postcss-scss, and use the "customSyntax" option',
	);
	});
	it('rejects when customSyntax and syntax are set', async () => {
	const config = {
	rules: {
	'block-no-empty': true,
	},
	};
	await expect(
	standalone({
	config,
	syntax: 'less',
	customSyntax: `${fixturesPath}/custom-syntax`,
	code: '$foo: bar; // foo;\nb {}',
	formatter: stringFormatter,
	}),
	).rejects.toThrow(
	'The "syntax" option is no longer available. You should install an appropriate syntax, e.g. postcss-scss, and use the "customSyntax" option',
	);
	});

Should I remove these 2 tests?

[fpetrakov]

I've also found these:

stylelint/lib/cli.js

Line 47 in e3585ed

* @property {string} [syntax]

stylelint/lib/cli.js

Line 83 in e3585ed

* @property {string} [syntax]

stylelint/lib/cli.js

Lines 332 to 335 in e3585ed

	syntax: {
	alias: 's',
	type: 'string',
	},

stylelint/lib/cli.js

Lines 374 to 376 in e3585ed

	if (cli.flags.syntax) {
	optionsBase.syntax = cli.flags.syntax;
	}

[ybiquitous]

Thanks, all the changes look good! Is it possible to remove also syntax occurrences in the type definition?

stylelint/types/stylelint/index.d.ts

Line 211 in e3585ed

syntax?: string;

stylelint/types/stylelint/index.d.ts

Line 536 in e3585ed

export type PostcssPluginOptions = Omit<LinterOptions, 'syntax' | 'customSyntax'> | Config;

[ybiquitous]

Could you add a changelog entry with the following content via npx changeset add (major)?

Removed: `syntax` option

[ybiquitous]

Thank you! LGTM 👍🏼

[jeddy3]

LGTM, thank you!