Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FEATURE] Add JSDoc build functionalities #42

Merged
merged 38 commits into from
Mar 21, 2019
Merged

[FEATURE] Add JSDoc build functionalities #42

merged 38 commits into from
Mar 21, 2019

Commits on Mar 18, 2019

  1. [WIP] Task to create JSDoc for a library, using the UI5 template/plugin 

    Note: the code is full of console.log just to track down an unexpected
      exit of the Node.js process.
    @codeworrior @RandomByte
    codeworrior authored and RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    98dbe0f View commit details
    Browse the repository at this point in the history

  2. Refactoring based on concept work

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    302e2df View commit details
    Browse the repository at this point in the history

  3. Remove cross spawn + add tests

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    7f74ab7 View commit details
    Browse the repository at this point in the history

  4. JSDoc: configure destination path + refactor API signatures

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    e0d2325 View commit details
    Browse the repository at this point in the history

  5. Fix tmp dir cleanup

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    454211b View commit details
    Browse the repository at this point in the history

  6. Fix ESLint errors

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    965d5d2 View commit details
    Browse the repository at this point in the history

  7. Add jsdocGenerater processor unit tests

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    7fcce69 View commit details
    Browse the repository at this point in the history

  8. Refactor jsdocGenerator: Move main function to top + add JSDoc for pr… 

    …ivate functions
    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    c0e3c38 View commit details
    Browse the repository at this point in the history

  9. Refactor generateJsdoc task

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    130a9c9 View commit details
    Browse the repository at this point in the history

  10. Add generateJsdoc test file

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    c26f2de View commit details
    Browse the repository at this point in the history

  11. Add generateJsdoc task unit tests

    @devtomtom @RandomByte
    devtomtom authored and RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    4eb2826 View commit details
    Browse the repository at this point in the history

  12. Fix make-dir mock in task tests

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    3e537a0 View commit details
    Browse the repository at this point in the history

  13. Add tests for generateJsdoc task

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    28fe452 View commit details
    Browse the repository at this point in the history

  14. Add basic integration test for JSDoc generation

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    9c1885f View commit details
    Browse the repository at this point in the history

  15. Sanitize project name before using it in directory name

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    1ebd6c0 View commit details
    Browse the repository at this point in the history

  16. Improve generateJsdoc unit tests

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    d633cdb View commit details
    Browse the repository at this point in the history

  17. Refactor jsdoc processor internal files into lib dir

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    006702c View commit details
    Browse the repository at this point in the history

  18. Collect dependency APIs

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    ef0c52e View commit details
    Browse the repository at this point in the history

  19. Add handling for exclude patterns defined in project configuration

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    2e2a663 View commit details
    Browse the repository at this point in the history

  20. Update JSDoc template and plugin from grunt tooling (openui5 master) 

    As these resources are shared with the jsdoc-maven-plugin which still
allows to use an older Node.JS version, all modernization (es6+) as well
as eslint fixes had to be reverted for now.

To compensate for this, the shared resources are excluded from linting.
    @codeworrior @RandomByte
    codeworrior authored and RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    a156d61 View commit details
    Browse the repository at this point in the history

  21. Ignore non-existent output files 

    When the JSDoc build is combined with --all, it might also run for
themelibs which don't produce any JSDoc output.
    @codeworrior @RandomByte
    codeworrior authored and RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    ccfb255 View commit details
    Browse the repository at this point in the history

  22. Fix ESLint and JSDoc errors 

    And trim some whitespaces
    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    bea340c View commit details
    Browse the repository at this point in the history

  23. Fix tests on Windows

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    606504c View commit details
    Browse the repository at this point in the history

  24. JSDoc config JSON: Fix paths on Windows

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    68df5e7 View commit details
    Browse the repository at this point in the history

  25. Builder: Add JSDoc build option

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    0b17227 View commit details
    Browse the repository at this point in the history

  26. Add SDK Transformation task and processor

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    c63372c View commit details
    Browse the repository at this point in the history

  27. executeJsdocSdkTransformation: Throw error if too many project api.js… 

    …on or .library resources are found

Globs may return resources in random order, therefore choosing the first
of many matches can lead to erratic results.
    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    f085fad View commit details
    Browse the repository at this point in the history

  28. executeJsdocSdkTransformation: Add tests

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    89f7792 View commit details
    Browse the repository at this point in the history

  29. sdkTransformer: Add tests

    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    b8f9768 View commit details
    Browse the repository at this point in the history

  30. executeJsdocSdkTransformation: Skip projects with missing api.json 

    Prominent example: theme libraries
    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    b3bdf80 View commit details
    Browse the repository at this point in the history

  31. generateJsdoc: Always create tmp dirs 

    This prevents JSDoc errors in case no resources have written to the
source path.
    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    88eda89 View commit details
    Browse the repository at this point in the history

  32. generateJsdoc: Skip JSDoc processing if no input resources have been … 

    …located

Prominent example: theme libraries
    @RandomByte
    RandomByte committed Mar 18, 2019
    Configuration menu
    Copy the full SHA
    8272acb View commit details
    Browse the repository at this point in the history

Commits on Mar 19, 2019

  1. Update JSDoc lib files from OpenUI5 change

    @RandomByte
    RandomByte committed Mar 19, 2019
    Configuration menu
    Copy the full SHA
    769f201 View commit details
    Browse the repository at this point in the history

  2. Add generateApiIndex task

    @RandomByte
    RandomByte committed Mar 19, 2019
    Configuration menu
    Copy the full SHA
    652d0cd View commit details
    Browse the repository at this point in the history

Commits on Mar 20, 2019

  1. apiIndexGenerator: Rename variables

    @RandomByte
    RandomByte committed Mar 20, 2019
    Configuration menu
    Copy the full SHA
    413ccf0 View commit details
    Browse the repository at this point in the history

  2. Add tests for generateApiIndex task and processor

    @RandomByte
    RandomByte committed Mar 20, 2019
    Configuration menu
    Copy the full SHA
    5905a2e View commit details
    Browse the repository at this point in the history

Commits on Mar 21, 2019

  1. Make theme build default task for JSDoc build 

    As css files are required for a working SDK
    @RandomByte
    RandomByte committed Mar 21, 2019
    Configuration menu
    Copy the full SHA
    b82ac65 View commit details
    Browse the repository at this point in the history

  2. Also disable replaceCopyright and replaceVersion tasks in JSDoc build 

    They are not necessary in preview/dev scenarios
    @RandomByte
    RandomByte committed Mar 21, 2019
    Configuration menu
    Copy the full SHA
    b61c7d0 View commit details
    Browse the repository at this point in the history