added tests and comments

Author: j-castellanos

packages/eslint-config-airbnb-base/test/requires.js

@@ -8,6 +8,7 @@ test('all entry points parse', (t) => {
   t.doesNotThrow(() => require('..'), 'index does not throw');
   t.doesNotThrow(() => require('../legacy'), 'legacy does not throw');
   t.doesNotThrow(() => require('../whitespace'), 'whitespace does not throw');
+  t.doesNotThrow(() => require('../flat'), 'flat does not throw');
 
   t.end();
 });

packages/eslint-config-airbnb-base/test/test-flat-parity.js

@@ -0,0 +1,54 @@
+import test from 'tape';
+
+import flatConfig from '../flat';
+
+import bestPractices from '../rules/best-practices';
+import errors from '../rules/errors';
+import es6 from '../rules/es6';
+import imports from '../rules/imports';
+import node from '../rules/node';
+import strict from '../rules/strict';
+import style from '../rules/style';
+import variables from '../rules/variables';
+
+test('flat config includes all rules from rule files', (t) => {
+  // The flat config is an array with one config object
+  t.ok(Array.isArray(flatConfig), 'flat config is an array');
+  t.equal(flatConfig.length, 1, 'flat config has one element');
+
+  const flatRules = flatConfig[0].rules;
+
+  // Merge rules in the same order as flat.js
+  const expectedRules = {
+    ...bestPractices.rules,
+    ...errors.rules,
+    ...node.rules,
+    ...style.rules,
+    ...variables.rules,
+    ...es6.rules,
+    ...imports.rules,
+    ...strict.rules,
+  };
+
+  const flatKeys = Object.keys(flatRules).sort();
+  const expectedKeys = Object.keys(expectedRules).sort();
+
+  t.deepEqual(flatKeys, expectedKeys, 'flat config has the same rule keys as combined rule files');
+
+  expectedKeys.forEach((key) => {
+    t.deepEqual(flatRules[key], expectedRules[key], `rule "${key}" has matching config`);
+  });
+
+  t.end();
+});
+
+test('flat config has required plugins and settings', (t) => {
+  const config = flatConfig[0];
+
+  t.ok(config.plugins.import, 'import plugin is present');
+  t.ok(config.settings, 'settings are present');
+  t.ok(config.languageOptions, 'languageOptions are present');
+  t.equal(config.languageOptions.sourceType, 'module', 'sourceType is module');
+
+  t.end();
+});

packages/eslint-config-airbnb-base/whitespace-async.js

@@ -4,6 +4,7 @@ const { isArray } = Array;
 const { entries } = Object;
 const { ESLint } = require('eslint');
 
+// ESLint 9 transition-period API; will be moot once eslintrc is fully removed in ESLint 10+
 const isFlat = ESLint.configType === 'flat';
 const baseConfig = isFlat ? require('./flat') : require('.');
 const whitespaceRules = require('./whitespaceRules');

packages/eslint-config-airbnb-base/whitespace.js

@@ -60,6 +60,7 @@ if (CLIEngine) {
     }
   })));
 
+  // ESLint 9 transition-period API; will be moot once eslintrc is fully removed in ESLint 10+
   if (ESLint.configType === 'flat') {
     // In flat mode, whitespace-async.js outputs only { rules: {} } since plugins
     // are not JSON-serializable. Merge the rule overrides with the full flat config

packages/eslint-config-airbnb/test/requires.js

@@ -10,6 +10,9 @@ test('all entry points parse', (t) => {
   t.doesNotThrow(() => require('../legacy'), 'legacy does not throw');
   t.doesNotThrow(() => require('../whitespace'), 'whitespace does not throw');
   t.doesNotThrow(() => require('../hooks'), 'hooks does not throw');
+  t.doesNotThrow(() => require('../flat'), 'flat does not throw');
+  t.doesNotThrow(() => require('../flat-base'), 'flat-base does not throw');
+  t.doesNotThrow(() => require('../flat-hooks'), 'flat-hooks does not throw');
 
   t.end();
 });

packages/eslint-config-airbnb/test/test-flat-parity.js

@@ -0,0 +1,86 @@
+import test from 'tape';
+
+import flatConfig from '../flat';
+
+import bestPractices from 'eslint-config-airbnb-base/rules/best-practices';
+import errors from 'eslint-config-airbnb-base/rules/errors';
+import es6 from 'eslint-config-airbnb-base/rules/es6';
+import imports from 'eslint-config-airbnb-base/rules/imports';
+import node from 'eslint-config-airbnb-base/rules/node';
+import strict from 'eslint-config-airbnb-base/rules/strict';
+import style from 'eslint-config-airbnb-base/rules/style';
+import variables from 'eslint-config-airbnb-base/rules/variables';
+
+import react from '../rules/react';
+import reactA11y from '../rules/react-a11y';
+
+test('flat config structure', (t) => {
+  t.ok(Array.isArray(flatConfig), 'flat config is an array');
+  t.equal(flatConfig.length, 2, 'flat config has two elements (base + react)');
+
+  t.notOk(flatConfig[0].files, 'base config has no files scope');
+  t.deepEqual(flatConfig[1].files, ['**/*.{js,jsx,mjs,cjs}'], 'react config is scoped to JS files');
+
+  t.end();
+});
+
+test('flat config base rules match rule files', (t) => {
+  const baseRules = flatConfig[0].rules;
+
+  const expectedBaseRules = {
+    ...bestPractices.rules,
+    ...errors.rules,
+    ...node.rules,
+    ...style.rules,
+    ...variables.rules,
+    ...es6.rules,
+    ...imports.rules,
+    ...strict.rules,
+  };
+
+  const baseKeys = Object.keys(baseRules).sort();
+  const expectedKeys = Object.keys(expectedBaseRules).sort();
+
+  t.deepEqual(baseKeys, expectedKeys, 'base config has the same rule keys as combined base rule files');
+
+  expectedKeys.forEach((key) => {
+    t.deepEqual(baseRules[key], expectedBaseRules[key], `base rule "${key}" has matching config`);
+  });
+
+  t.end();
+});
+
+test('flat config react rules match rule files', (t) => {
+  const reactRules = flatConfig[1].rules;
+
+  const expectedReactRules = {
+    ...react.rules,
+    ...reactA11y.rules,
+  };
+
+  const reactKeys = Object.keys(reactRules).sort();
+  const expectedKeys = Object.keys(expectedReactRules).sort();
+
+  t.deepEqual(reactKeys, expectedKeys, 'react config has the same rule keys as combined react rule files');
+
+  expectedKeys.forEach((key) => {
+    t.deepEqual(reactRules[key], expectedReactRules[key], `react rule "${key}" has matching config`);
+  });
+
+  t.end();
+});
+
+test('flat config has required plugins and settings', (t) => {
+  const baseConfig = flatConfig[0];
+  const reactConfig = flatConfig[1];
+
+  t.ok(baseConfig.plugins.import, 'import plugin is present in base config');
+  t.ok(baseConfig.settings, 'settings are present in base config');
+  t.ok(baseConfig.languageOptions, 'languageOptions are present in base config');
+
+  t.ok(reactConfig.plugins.react, 'react plugin is present in react config');
+  t.ok(reactConfig.plugins['jsx-a11y'], 'jsx-a11y plugin is present in react config');
+  t.ok(reactConfig.settings, 'settings are present in react config');
+
+  t.end();
+});

packages/eslint-config-airbnb/whitespace-async.js

@@ -4,6 +4,7 @@ const { isArray } = Array;
 const { entries } = Object;
 const { ESLint } = require('eslint');
 
+// ESLint 9 transition-period API; will be moot once eslintrc is fully removed in ESLint 10+
 const isFlat = ESLint.configType === 'flat';
 const baseConfig = isFlat ? require('./flat') : require('.');
 const whitespaceRules = require('./whitespaceRules');

packages/eslint-config-airbnb/whitespace.js

@@ -60,6 +60,7 @@ if (CLIEngine) {
     }
   })));
 
+  // ESLint 9 transition-period API; will be moot once eslintrc is fully removed in ESLint 10+
   if (ESLint.configType === 'flat') {
     // In flat mode, whitespace-async.js outputs only { rules: {} } since plugins
     // are not JSON-serializable. Merge the rule overrides with the full flat config