├── .eslintrc.js ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ └── bug_report.md └── workflows │ └── test_and_publish.yml ├── .gitignore ├── .prettierrc.json ├── .vscode ├── launch.json └── tasks.json ├── .vscodeignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── docs ├── docblockr.md ├── doxygen.md ├── google.md ├── numpy.md ├── one-line-sphinx.md ├── pep257.md └── sphinx.md ├── images ├── demo.gif └── icon.png ├── package.json ├── src ├── constants.ts ├── docstring │ ├── docstring_factory.ts │ ├── get_template.ts │ ├── index.ts │ ├── template_data.ts │ └── templates │ │ ├── docblockr.mustache │ │ ├── doxygen-notypes.mustache │ │ ├── doxygen.mustache │ │ ├── google-notypes.mustache │ │ ├── google.mustache │ │ ├── numpy-notypes.mustache │ │ ├── numpy.mustache │ │ ├── one-line-sphinx.mustache │ │ ├── pep257.mustache │ │ ├── sphinx-notypes.mustache │ │ └── sphinx.mustache ├── docstring_parts.ts ├── extension.ts ├── generate_docstring.ts ├── logger.ts ├── parse │ ├── docstring_is_closed.ts │ ├── get_body.ts │ ├── get_definition.ts │ ├── get_docstring_indentation.ts │ ├── get_function_name.ts │ ├── guess_type.ts │ ├── index.ts │ ├── parse.ts │ ├── parse_parameters.ts │ ├── tokenize_definition.ts │ ├── utilities.ts │ └── valid_docstring_prefix.ts ├── telemetry.ts └── test │ ├── docstring │ ├── custom_template_test.mustache │ ├── generate_docstring.spec.ts │ ├── get_custom_template.spec.ts │ └── get_template.spec.ts │ ├── index.ts │ ├── integration │ ├── index.ts │ ├── integration.test.ts │ └── python_test_files │ │ ├── file_1.py │ │ ├── file_1_output.py │ │ ├── file_2.py │ │ ├── file_2_output.py │ │ ├── file_3.py │ │ ├── file_3_output.py │ │ ├── file_4.py │ │ ├── file_4_output.py │ │ ├── file_5.py │ │ ├── file_5_output.py │ │ ├── file_6.py │ │ ├── file_6_output.py │ │ ├── file_7.py │ │ ├── file_7_output.py │ │ ├── file_bazel.bzl │ │ ├── file_bazel_output.bzl │ │ ├── file_starlark.sky │ │ └── file_starlark_output.sky │ ├── parse │ ├── docstring_is_closed.spec.ts │ ├── get_body.spec.ts │ ├── get_definition.spec.ts │ ├── get_docstring_indentation.spec.ts │ ├── get_function_name.spec.ts │ ├── guess_type.spec.ts │ ├── parse_parameters.spec.ts │ ├── tokenize_definition.spec.ts │ ├── utilities.spec.ts │ └── valid_docstring_prefix.spec.ts │ └── run_integration_tests.ts └── tsconfig.json /.eslintrc.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.eslintrc.js -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: NilsJPWerner 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.github/ISSUE_TEMPLATE/bug_report.md -------------------------------------------------------------------------------- /.github/workflows/test_and_publish.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.github/workflows/test_and_publish.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.gitignore -------------------------------------------------------------------------------- /.prettierrc.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.prettierrc.json -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.vscode/launch.json -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.vscode/tasks.json -------------------------------------------------------------------------------- /.vscodeignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/.vscodeignore -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/CHANGELOG.md -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/README.md -------------------------------------------------------------------------------- /docs/docblockr.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/docblockr.md -------------------------------------------------------------------------------- /docs/doxygen.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/doxygen.md -------------------------------------------------------------------------------- /docs/google.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/google.md -------------------------------------------------------------------------------- /docs/numpy.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/numpy.md -------------------------------------------------------------------------------- /docs/one-line-sphinx.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/one-line-sphinx.md -------------------------------------------------------------------------------- /docs/pep257.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/pep257.md -------------------------------------------------------------------------------- /docs/sphinx.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/docs/sphinx.md -------------------------------------------------------------------------------- /images/demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/images/demo.gif -------------------------------------------------------------------------------- /images/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/images/icon.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/package.json -------------------------------------------------------------------------------- /src/constants.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/constants.ts -------------------------------------------------------------------------------- /src/docstring/docstring_factory.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/docstring_factory.ts -------------------------------------------------------------------------------- /src/docstring/get_template.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/get_template.ts -------------------------------------------------------------------------------- /src/docstring/index.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/index.ts -------------------------------------------------------------------------------- /src/docstring/template_data.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/template_data.ts -------------------------------------------------------------------------------- /src/docstring/templates/docblockr.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/docblockr.mustache -------------------------------------------------------------------------------- /src/docstring/templates/doxygen-notypes.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/doxygen-notypes.mustache -------------------------------------------------------------------------------- /src/docstring/templates/doxygen.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/doxygen.mustache -------------------------------------------------------------------------------- /src/docstring/templates/google-notypes.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/google-notypes.mustache -------------------------------------------------------------------------------- /src/docstring/templates/google.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/google.mustache -------------------------------------------------------------------------------- /src/docstring/templates/numpy-notypes.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/numpy-notypes.mustache -------------------------------------------------------------------------------- /src/docstring/templates/numpy.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/numpy.mustache -------------------------------------------------------------------------------- /src/docstring/templates/one-line-sphinx.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/one-line-sphinx.mustache -------------------------------------------------------------------------------- /src/docstring/templates/pep257.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/pep257.mustache -------------------------------------------------------------------------------- /src/docstring/templates/sphinx-notypes.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/sphinx-notypes.mustache -------------------------------------------------------------------------------- /src/docstring/templates/sphinx.mustache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring/templates/sphinx.mustache -------------------------------------------------------------------------------- /src/docstring_parts.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/docstring_parts.ts -------------------------------------------------------------------------------- /src/extension.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/extension.ts -------------------------------------------------------------------------------- /src/generate_docstring.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/generate_docstring.ts -------------------------------------------------------------------------------- /src/logger.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/logger.ts -------------------------------------------------------------------------------- /src/parse/docstring_is_closed.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/docstring_is_closed.ts -------------------------------------------------------------------------------- /src/parse/get_body.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/get_body.ts -------------------------------------------------------------------------------- /src/parse/get_definition.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/get_definition.ts -------------------------------------------------------------------------------- /src/parse/get_docstring_indentation.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/get_docstring_indentation.ts -------------------------------------------------------------------------------- /src/parse/get_function_name.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/get_function_name.ts -------------------------------------------------------------------------------- /src/parse/guess_type.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/guess_type.ts -------------------------------------------------------------------------------- /src/parse/index.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/index.ts -------------------------------------------------------------------------------- /src/parse/parse.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/parse.ts -------------------------------------------------------------------------------- /src/parse/parse_parameters.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/parse_parameters.ts -------------------------------------------------------------------------------- /src/parse/tokenize_definition.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/tokenize_definition.ts -------------------------------------------------------------------------------- /src/parse/utilities.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/utilities.ts -------------------------------------------------------------------------------- /src/parse/valid_docstring_prefix.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/parse/valid_docstring_prefix.ts -------------------------------------------------------------------------------- /src/telemetry.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/telemetry.ts -------------------------------------------------------------------------------- /src/test/docstring/custom_template_test.mustache: -------------------------------------------------------------------------------- 1 | {{! Custom Docstring Template }} 2 | -------------------------------------------------------------------------------- /src/test/docstring/generate_docstring.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/docstring/generate_docstring.spec.ts -------------------------------------------------------------------------------- /src/test/docstring/get_custom_template.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/docstring/get_custom_template.spec.ts -------------------------------------------------------------------------------- /src/test/docstring/get_template.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/docstring/get_template.spec.ts -------------------------------------------------------------------------------- /src/test/index.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/index.ts -------------------------------------------------------------------------------- /src/test/integration/index.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/index.ts -------------------------------------------------------------------------------- /src/test/integration/integration.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/integration.test.ts -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_1.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_1.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_1_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_1_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_2.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_2.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_2_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_2_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_3.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_3.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_3_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_3_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_4.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_4.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_4_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_4_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_5.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_5.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_5_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_5_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_6.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_6.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_6_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_6_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_7.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_7.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_7_output.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_7_output.py -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_bazel.bzl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_bazel.bzl -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_bazel_output.bzl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_bazel_output.bzl -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_starlark.sky: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_starlark.sky -------------------------------------------------------------------------------- /src/test/integration/python_test_files/file_starlark_output.sky: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/integration/python_test_files/file_starlark_output.sky -------------------------------------------------------------------------------- /src/test/parse/docstring_is_closed.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/docstring_is_closed.spec.ts -------------------------------------------------------------------------------- /src/test/parse/get_body.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/get_body.spec.ts -------------------------------------------------------------------------------- /src/test/parse/get_definition.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/get_definition.spec.ts -------------------------------------------------------------------------------- /src/test/parse/get_docstring_indentation.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/get_docstring_indentation.spec.ts -------------------------------------------------------------------------------- /src/test/parse/get_function_name.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/get_function_name.spec.ts -------------------------------------------------------------------------------- /src/test/parse/guess_type.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/guess_type.spec.ts -------------------------------------------------------------------------------- /src/test/parse/parse_parameters.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/parse_parameters.spec.ts -------------------------------------------------------------------------------- /src/test/parse/tokenize_definition.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/tokenize_definition.spec.ts -------------------------------------------------------------------------------- /src/test/parse/utilities.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/utilities.spec.ts -------------------------------------------------------------------------------- /src/test/parse/valid_docstring_prefix.spec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/parse/valid_docstring_prefix.spec.ts -------------------------------------------------------------------------------- /src/test/run_integration_tests.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/src/test/run_integration_tests.ts -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NilsJPWerner/autoDocstring/HEAD/tsconfig.json --------------------------------------------------------------------------------