style: Format IMPORTANT_FILES list for improved readability

This commit is contained in:
Paul Gauthier (aider) 2024-08-30 14:35:06 -07:00
parent 2cb13b5ebb
commit 3191e85857

View file

@ -2,66 +2,162 @@ import os
IMPORTANT_FILES = [ IMPORTANT_FILES = [
# Version Control # Version Control
".gitignore", ".gitattributes", ".gitignore",
".gitattributes",
# Documentation # Documentation
"README.md", "CONTRIBUTING.md", "LICENSE", "CHANGELOG.md", "SECURITY.md", "CODEOWNERS", "README.md",
"CONTRIBUTING.md",
"LICENSE",
"CHANGELOG.md",
"SECURITY.md",
"CODEOWNERS",
# Package Management and Dependencies # Package Management and Dependencies
"requirements.txt", "Pipfile", "pyproject.toml", "setup.py", "requirements.txt",
"package.json", "package-lock.json", "yarn.lock", "npm-shrinkwrap.json", "Pipfile",
"Gemfile", "Gemfile.lock", "composer.json", "composer.lock", "pyproject.toml",
"pom.xml", "build.gradle", "build.sbt", "go.mod", "go.sum", "setup.py",
"Cargo.toml", "Cargo.lock", "mix.exs", "rebar.config", "project.clj", "package.json",
"Podfile", "Cartfile", "dub.json", "dub.sdl", "package-lock.json",
"yarn.lock",
"npm-shrinkwrap.json",
"Gemfile",
"Gemfile.lock",
"composer.json",
"composer.lock",
"pom.xml",
"build.gradle",
"build.sbt",
"go.mod",
"go.sum",
"Cargo.toml",
"Cargo.lock",
"mix.exs",
"rebar.config",
"project.clj",
"Podfile",
"Cartfile",
"dub.json",
"dub.sdl",
# Configuration and Settings # Configuration and Settings
".env", ".env.example", ".editorconfig", "tsconfig.json", "jsconfig.json", ".env",
".babelrc", "babel.config.js", ".eslintrc", ".eslintignore", ".env.example",
".prettierrc", ".stylelintrc", "tslint.json", ".pylintrc", ".flake8", ".editorconfig",
".rubocop.yml", ".scalafmt.conf", ".dockerignore", ".gitpod.yml", "tsconfig.json",
"sonar-project.properties", "renovate.json", "dependabot.yml", "jsconfig.json",
".babelrc",
"babel.config.js",
".eslintrc",
".eslintignore",
".prettierrc",
".stylelintrc",
"tslint.json",
".pylintrc",
".flake8",
".rubocop.yml",
".scalafmt.conf",
".dockerignore",
".gitpod.yml",
"sonar-project.properties",
"renovate.json",
"dependabot.yml",
# Build and Compilation # Build and Compilation
"Makefile", "CMakeLists.txt", "webpack.config.js", "rollup.config.js", "Makefile",
"parcel.config.js", "gulpfile.js", "Gruntfile.js", "CMakeLists.txt",
"build.xml", "build.boot", "project.json", "build.cake", "webpack.config.js",
"rollup.config.js",
"parcel.config.js",
"gulpfile.js",
"Gruntfile.js",
"build.xml",
"build.boot",
"project.json",
"build.cake",
# Testing # Testing
"pytest.ini", "phpunit.xml", "karma.conf.js", "jest.config.js", "cypress.json", "pytest.ini",
"phpunit.xml",
"karma.conf.js",
"jest.config.js",
"cypress.json",
# CI/CD # CI/CD
".travis.yml", ".gitlab-ci.yml", "Jenkinsfile", "azure-pipelines.yml", ".travis.yml",
"bitbucket-pipelines.yml", "appveyor.yml", "circle.yml", ".circleci/config.yml", ".gitlab-ci.yml",
"Jenkinsfile",
"azure-pipelines.yml",
"bitbucket-pipelines.yml",
"appveyor.yml",
"circle.yml",
".circleci/config.yml",
# Docker and Containers # Docker and Containers
"Dockerfile", "docker-compose.yml", "docker-compose.override.yml", "Dockerfile",
"docker-compose.yml",
"docker-compose.override.yml",
# Cloud and Serverless # Cloud and Serverless
"serverless.yml", "firebase.json", "now.json", "netlify.toml", "vercel.json", "app.yaml", "serverless.yml",
"terraform.tf", "main.tf", "cloudformation.yaml", "cloudformation.json", "firebase.json",
"ansible.cfg", "kubernetes.yaml", "k8s.yaml", "now.json",
"netlify.toml",
"vercel.json",
"app.yaml",
"terraform.tf",
"main.tf",
"cloudformation.yaml",
"cloudformation.json",
"ansible.cfg",
"kubernetes.yaml",
"k8s.yaml",
# Database # Database
"schema.sql", "liquibase.properties", "flyway.conf", "schema.sql",
"liquibase.properties",
"flyway.conf",
# Framework-specific # Framework-specific
"manage.py", "settings.py", # Django "manage.py",
"config/routes.rb", "Rakefile", # Ruby on Rails "settings.py", # Django
"next.config.js", "nuxt.config.js", # Next.js, Nuxt.js "config/routes.rb",
"vue.config.js", "angular.json", # Vue.js, Angular "Rakefile", # Ruby on Rails
"gatsby-config.js", "gridsome.config.js", # Gatsby, Gridsome "next.config.js",
"nuxt.config.js", # Next.js, Nuxt.js
"vue.config.js",
"angular.json", # Vue.js, Angular
"gatsby-config.js",
"gridsome.config.js", # Gatsby, Gridsome
# API Documentation # API Documentation
"swagger.yaml", "swagger.json", "openapi.yaml", "openapi.json", "swagger.yaml",
"swagger.json",
"openapi.yaml",
"openapi.json",
# Language-specific # Language-specific
"__init__.py", # Python "__init__.py", # Python
"stack.yaml", "package.yaml", # Haskell "stack.yaml",
"package.yaml", # Haskell
".htaccess", # Apache ".htaccess", # Apache
# Development environment # Development environment
".nvmrc", ".ruby-version", ".python-version", "Vagrantfile", ".nvmrc",
".ruby-version",
".python-version",
"Vagrantfile",
# Quality and metrics # Quality and metrics
".codeclimate.yml", ".coveragerc", "codecov.yml", ".codeclimate.yml",
".coveragerc",
"codecov.yml",
# Documentation # Documentation
"mkdocs.yml", "_config.yml", "book.toml", "mkdocs.yml",
"_config.yml",
"book.toml",
# Package registries # Package registries
".npmrc", ".yarnrc", ".npmrc",
".yarnrc",
# IDE and Editor # IDE and Editor
".vscode/settings.json", ".idea/workspace.xml", ".vscode/settings.json",
".sublime-project", ".vim", "_vimrc", ".idea/workspace.xml",
".sublime-project",
".vim",
"_vimrc",
# Misc # Misc
"CODEOWNERS", ".pypirc", "CODEOWNERS",
".pypirc",
] ]
def filter_important_files(file_paths): def filter_important_files(file_paths):
""" """
Filter a list of file paths to return only those that are commonly important in codebases. Filter a list of file paths to return only those that are commonly important in codebases.
@ -69,6 +165,7 @@ def filter_important_files(file_paths):
:param file_paths: List of file paths to check :param file_paths: List of file paths to check
:return: List of file paths that match important file patterns :return: List of file paths that match important file patterns
""" """
def is_important(file_path): def is_important(file_path):
file_name = os.path.basename(file_path) file_name = os.path.basename(file_path)
dir_name = os.path.dirname(file_path) dir_name = os.path.dirname(file_path)