ESLint Aws ApiGW v1 restApi rules for Eslint 9+ with flat config

forbidden-rest-api-flags.cjs

module.exports = {
  rules: {
    'forbidden-rest-api-flags': {
      meta: {
        'type': 'problem',
        docs: {
          description: 'Dissallow the use of certain flags on rest api objects as they mess up other deployed rest apis in the same AWS account',
          category: 'Best Practices',
          recommended: false,
        },
        schema: [],
      },
      create: function (context) {
        return {
          Identifier(node) {
            if (node.name === 'cloudWatchRole') {
              context.report({
                node,
                message: 'Usage of cloudWatchRole is not allowed on restApi objects outside the asset connectivity shared infra repo.\nThis because any AWS account can only have one resource setting the region-global cloudWatchRole per region\n Please ignore this rule if you are setting this property on something else than restApi',
              });
            }
            if (node.name === 'privateDnsEnabled' && node?.parent?.value?.value === true) {
              context.report({
                node,
                message: 'Setting privateDnsEnabled to true is not allowed.\nIt would bring all other privately hosted APIs in the same AWS account offline.\n Please ignore this rule if you are setting this property on something else than restApi',
              });
            }
          },
        };
      },
    }
  }
}

then in your eslint.config.js file (ESLint 9+ flat)

import forbiddenRestApiFlags from './scripts/forbidden-rest-api-flags.cjs';

export default tseslint.config(
  { ignores: ['dist', 'docs', 'scripts', 'coverage', 'playwright.config.ts'] },
  {
    extends: [
      ...whatever
    ],
    files: ['**/*.{ts,tsx}'],
    languageOptions: {
      ...whatever
    },
    plugins: {
      ...otherPlugins
      'forbidden-rest-api-flags': forbiddenRestApiFlags,
    },
    rules: {
      ...otherRules,
      'forbidden-rest-api-flags/forbidden-rest-api-flags': 'error',
    },
  },
)

Reult:

License for the work above

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org

HendrikPetertje/eslint-restApi.md

License for the work above