Remove syntax option (#6420)

.changeset/nervous-insects-design.md

@@ -0,0 +1,5 @@
+---
+"stylelint": major
+---
+
+Removed: `syntax` option

lib/__tests__/cli.test.js

@@ -160,11 +160,6 @@ describe('buildCLI', () => {
 		expect(buildCLI(['--stdin-filename=foo.css']).flags.stdinFilename).toBe('foo.css');
 	});
 
-	it('flags.syntax', () => {
-		expect(buildCLI(['--syntax=less']).flags.syntax).toBe('less');
-		expect(buildCLI(['-s', 'less']).flags.syntax).toBe('less');
-	});
-
 	it('flags.version', () => {
 		expect(buildCLI(['--version']).flags.version).toBe(true);
 		expect(buildCLI(['-v']).flags.version).toBe(true);

lib/__tests__/standalone-syntax.test.js

@@ -150,38 +150,6 @@ it('rejects on unknown custom syntax option', async () => {
 	);
 });
 
-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',
-	);
-});
-
 describe('customSyntax set in the config', () => {
 	it('standalone with path to custom parser', async () => {
 		const config = {

lib/cli.js

@@ -44,7 +44,6 @@ const EXIT_CODE_ERROR = 2;
  * @property {boolean} [reportDescriptionlessDisables]
  * @property {number} [maxWarnings]
  * @property {boolean} quiet
- * @property {string} [syntax]
  * @property {string} [version]
  * @property {boolean} [allowEmptyInput]
  */
@@ -80,7 +79,6 @@ const EXIT_CODE_ERROR = 2;
  * @property {boolean} [reportDescriptionlessDisables]
  * @property {boolean} [disableDefaultIgnores]
  * @property {number} [maxWarnings]
- * @property {string} [syntax]
  * @property {string[]} [ignorePattern]
  * @property {boolean} [allowEmptyInput]
  * @property {string} [files]
@@ -329,10 +327,6 @@ const meowOptions = {
 		stdinFilename: {
 			type: 'string',
 		},
-		syntax: {
-			alias: 's',
-			type: 'string',
-		},
 		version: {
 			alias: 'v',
 			type: 'boolean',
@@ -371,10 +365,6 @@ module.exports = async (argv) => {
 		optionsBase.quiet = cli.flags.quiet;
 	}
 
-	if (cli.flags.syntax) {
-		optionsBase.syntax = cli.flags.syntax;
-	}
-
 	if (cli.flags.customSyntax) {
 		optionsBase.customSyntax = getModulePath(process.cwd(), cli.flags.customSyntax);
 	}

lib/getPostcssResult.js

@@ -26,17 +26,6 @@ module.exports = async function getPostcssResult(stylelint, options = {}) {
 		return cached;
 	}
 
-	if (stylelint._options.syntax) {
-		let error = 'The "syntax" option is no longer available. ';
-
-		error +=
-			stylelint._options.syntax === 'css'
-				? 'You can remove the "--syntax" CLI flag as stylelint will now parse files as CSS by default'
-				: `You should install an appropriate syntax, e.g. postcss-scss, and use the "customSyntax" option`;
-
-		return Promise.reject(new Error(error));
-	}
-
 	const syntax = options.customSyntax
 		? getCustomSyntax(options.customSyntax)
 		: cssSyntax(stylelint, options.filePath);

lib/standalone.js

@@ -58,7 +58,6 @@ async function standalone({
 	reportDescriptionlessDisables,
 	reportInvalidScopeDisables,
 	reportNeedlessDisables,
-	syntax,
 }) {
 	const startTime = Date.now();
 
@@ -103,7 +102,6 @@ async function standalone({
 		reportNeedlessDisables,
 		reportInvalidScopeDisables,
 		reportDescriptionlessDisables,
-		syntax,
 		customSyntax,
 		fix,
 		quiet,

types/stylelint/index.d.ts

@@ -208,7 +208,6 @@ declare module 'stylelint' {
 			codeFilename?: string;
 			filePath?: string;
 			codeProcessors?: CodeProcessor[];
-			syntax?: string;
 			customSyntax?: CustomSyntax;
 		};
 
@@ -240,8 +239,6 @@ declare module 'stylelint' {
 			reportNeedlessDisables?: boolean;
 			reportInvalidScopeDisables?: boolean;
 			maxWarnings?: number;
-			/** @deprecated Use `customSyntax` instead. Using this option will result in an error. */
-			syntax?: string;
 			customSyntax?: CustomSyntax;
 			formatter?: FormatterType | Formatter;
 			disableDefaultIgnores?: boolean;
@@ -533,7 +530,7 @@ declare module 'stylelint' {
 
 		export type DisableOptionsReport = DisableReportEntry[];
 
-		export type PostcssPluginOptions = Omit<LinterOptions, 'syntax' | 'customSyntax'> | Config;
+		export type PostcssPluginOptions = Omit<LinterOptions, 'customSyntax'> | Config;
 	}
 
 	const stylelint: stylelint.PublicApi;

types/stylelint/type-test.ts

@@ -34,7 +34,6 @@ const options: Partial<LinterOptions> = {
 	reportNeedlessDisables: true,
 	ignorePath: ['foo'],
 	customSyntax: 'postcss-scss',
-	syntax: 'scss', // Removed but still accepted in type definition
 	config: {
 		overrides: [
 			{