wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-13 17:56:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Popups/Doxyfile

30 lines
913 B
Plaintext
Raw Permalink Normal View History

build: Fix gaps in lint coverage and update old patterns eslint: * Remove hardcoded glob paths that are (relatively slow) to expand before linting could start, in favour of specifying directories which can be iterated while linting happens. * JSON files in i18n/ were skipped, unlike other repos. JS code under .storybook/ was skipped. JS code under resources/ext.popups/ was skipped. Fix all these by doing what other repos do, which is to let ESLint iterate the repository and tell it which directories not to enter. This has the happy side-effect of making IDE integrations for ESLint work correctly (as customisation in package.json has the same problems as using Gruntfile, namely that invoking 'eslint' directly can't be aware of this), as well as allowing things like `eslint --fix` to be used. ``` /Popups/resources/ext.popups/index.js 4:2 error Unexpected var, use let or const instead no-var ``` nyc: * Remove SPAWN_WRAP_SHIM_ROOT. This was a hack for an early CI experiment that hasn't been needed for several years. storybook: * Remove gitignore entries for additional npm and build output in the storybook subdirectory, which appears to not exist anymore since 189b386a1318159. Doxygen: * Sync with cookiecutter example from https://gerrit.wikimedia.org/g/mediawiki/tools/cookiecutter-library/+/HEAD/ - remove redundant stuff, - enable quiet mode to hide verbose non-warning, - include CoC. Change-Id: If8f6b833067192aea96a87f04c7978c9af11f996
2021-08-12 16:10:23 +00:00
# Doxyfile <https://www.doxygen.nl/manual/config.html>
docs: Generate documentation with Doxygen doc.wikimedia.org is a helpful resource when iterating on a codebase. Like MobileFrontend, generate documentation with Doxygen so that it can be published there. Note well that: - The CALL_GRAPH and CALLER_GRAPH statements have been removed as they were being set to the default value (NO) - DOT_FONTSIZE was increased from 10 to 12 Bug: T242779 Change-Id: I41e4c6ca2b604382b036606ebcb40f11a1e8abc0
2020-02-24 14:27:08 +00:00
PROJECT_NAME = Popups
PROJECT_BRIEF = "Displays page/reference previews when hovering over a link to an article/reference."
OUTPUT_DIRECTORY = docs
HTML_OUTPUT = php
# Intepret the first line of a comment as a brief description?
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = YES
WARN_NO_PARAMDOC = YES
build: Fix gaps in lint coverage and update old patterns eslint: * Remove hardcoded glob paths that are (relatively slow) to expand before linting could start, in favour of specifying directories which can be iterated while linting happens. * JSON files in i18n/ were skipped, unlike other repos. JS code under .storybook/ was skipped. JS code under resources/ext.popups/ was skipped. Fix all these by doing what other repos do, which is to let ESLint iterate the repository and tell it which directories not to enter. This has the happy side-effect of making IDE integrations for ESLint work correctly (as customisation in package.json has the same problems as using Gruntfile, namely that invoking 'eslint' directly can't be aware of this), as well as allowing things like `eslint --fix` to be used. ``` /Popups/resources/ext.popups/index.js 4:2 error Unexpected var, use let or const instead no-var ``` nyc: * Remove SPAWN_WRAP_SHIM_ROOT. This was a hack for an early CI experiment that hasn't been needed for several years. storybook: * Remove gitignore entries for additional npm and build output in the storybook subdirectory, which appears to not exist anymore since 189b386a1318159. Doxygen: * Sync with cookiecutter example from https://gerrit.wikimedia.org/g/mediawiki/tools/cookiecutter-library/+/HEAD/ - remove redundant stuff, - enable quiet mode to hide verbose non-warning, - include CoC. Change-Id: If8f6b833067192aea96a87f04c7978c9af11f996
2021-08-12 16:10:23 +00:00
QUIET = YES
docs: Generate documentation with Doxygen doc.wikimedia.org is a helpful resource when iterating on a codebase. Like MobileFrontend, generate documentation with Doxygen so that it can be published there. Note well that: - The CALL_GRAPH and CALLER_GRAPH statements have been removed as they were being set to the default value (NO) - DOT_FONTSIZE was increased from 10 to 12 Bug: T242779 Change-Id: I41e4c6ca2b604382b036606ebcb40f11a1e8abc0
2020-02-24 14:27:08 +00:00
build: Fix gaps in lint coverage and update old patterns eslint: * Remove hardcoded glob paths that are (relatively slow) to expand before linting could start, in favour of specifying directories which can be iterated while linting happens. * JSON files in i18n/ were skipped, unlike other repos. JS code under .storybook/ was skipped. JS code under resources/ext.popups/ was skipped. Fix all these by doing what other repos do, which is to let ESLint iterate the repository and tell it which directories not to enter. This has the happy side-effect of making IDE integrations for ESLint work correctly (as customisation in package.json has the same problems as using Gruntfile, namely that invoking 'eslint' directly can't be aware of this), as well as allowing things like `eslint --fix` to be used. ``` /Popups/resources/ext.popups/index.js 4:2 error Unexpected var, use let or const instead no-var ``` nyc: * Remove SPAWN_WRAP_SHIM_ROOT. This was a hack for an early CI experiment that hasn't been needed for several years. storybook: * Remove gitignore entries for additional npm and build output in the storybook subdirectory, which appears to not exist anymore since 189b386a1318159. Doxygen: * Sync with cookiecutter example from https://gerrit.wikimedia.org/g/mediawiki/tools/cookiecutter-library/+/HEAD/ - remove redundant stuff, - enable quiet mode to hide verbose non-warning, - include CoC. Change-Id: If8f6b833067192aea96a87f04c7978c9af11f996
2021-08-12 16:10:23 +00:00
INPUT = README.md CODE_OF_CONDUCT.md .
docs: Generate documentation with Doxygen doc.wikimedia.org is a helpful resource when iterating on a codebase. Like MobileFrontend, generate documentation with Doxygen so that it can be published there. Note well that: - The CALL_GRAPH and CALLER_GRAPH statements have been removed as they were being set to the default value (NO) - DOT_FONTSIZE was increased from 10 to 12 Bug: T242779 Change-Id: I41e4c6ca2b604382b036606ebcb40f11a1e8abc0
2020-02-24 14:27:08 +00:00
EXCLUDE_PATTERNS = doc docs vendor node_modules tests
FILE_PATTERNS = *.php
# Search through subdirectories for input files?
RECURSIVE = YES
# NOTE: USE_MDFILE_AS_MAINPAGE requires that the specified file is included as an input file.
build: Fix gaps in lint coverage and update old patterns eslint: * Remove hardcoded glob paths that are (relatively slow) to expand before linting could start, in favour of specifying directories which can be iterated while linting happens. * JSON files in i18n/ were skipped, unlike other repos. JS code under .storybook/ was skipped. JS code under resources/ext.popups/ was skipped. Fix all these by doing what other repos do, which is to let ESLint iterate the repository and tell it which directories not to enter. This has the happy side-effect of making IDE integrations for ESLint work correctly (as customisation in package.json has the same problems as using Gruntfile, namely that invoking 'eslint' directly can't be aware of this), as well as allowing things like `eslint --fix` to be used. ``` /Popups/resources/ext.popups/index.js 4:2 error Unexpected var, use let or const instead no-var ``` nyc: * Remove SPAWN_WRAP_SHIM_ROOT. This was a hack for an early CI experiment that hasn't been needed for several years. storybook: * Remove gitignore entries for additional npm and build output in the storybook subdirectory, which appears to not exist anymore since 189b386a1318159. Doxygen: * Sync with cookiecutter example from https://gerrit.wikimedia.org/g/mediawiki/tools/cookiecutter-library/+/HEAD/ - remove redundant stuff, - enable quiet mode to hide verbose non-warning, - include CoC. Change-Id: If8f6b833067192aea96a87f04c7978c9af11f996
2021-08-12 16:10:23 +00:00
USE_MDFILE_AS_MAINPAGE = README.md
docs: Generate documentation with Doxygen doc.wikimedia.org is a helpful resource when iterating on a codebase. Like MobileFrontend, generate documentation with Doxygen so that it can be published there. Note well that: - The CALL_GRAPH and CALLER_GRAPH statements have been removed as they were being set to the default value (NO) - DOT_FONTSIZE was increased from 10 to 12 Bug: T242779 Change-Id: I41e4c6ca2b604382b036606ebcb40f11a1e8abc0
2020-02-24 14:27:08 +00:00
HTML_DYNAMIC_SECTIONS = YES
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
GENERATE_LATEX = NO
Reference in a new issue Copy permalink