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.

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

Consider adding debugging/IDE files to cookiecutters #386

Closed
MeltyBot opened this issue May 19, 2022 · 3 comments
Closed

Consider adding debugging/IDE files to cookiecutters #386

MeltyBot opened this issue May 19, 2022 · 3 comments

Comments

@MeltyBot
Copy link
Contributor

Migrated from GitLab: https://gitlab.com/meltano/sdk/-/issues/389

Originally created by @edgarrmondragon on 2022-05-19 01:22:37


Summary

We could start with a simple VSCode launch.json.

Proposed benefits

Developers get a debugging configuration that works out of the box in one or more IDEs.

Proposal details

A templated .vscode/launch.json with the following contents

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "<config name>",
      "type": "python",
      "request": "launch",
      "cwd": "${workspaceFolder}",
      "program": "<package>",
      "args": [
        "--config",
        ".secrets/config.json"
      ]
    }
  ]
}

This might also require adding either of the following:

  • # tap_mysource/tap.py
    class TapMySource(Tap):
        ...
    
    if __name__ == "__main__":
        TapMySource.cli()
  • # tap_mysource/__main__.py
    
    from tap_mysource.tap import TapMySource
    
    TapMySource.cli()

Best reasons not to build

Any debug configuration could be too specific, but users can always tweak it.

@labelsync-manager labelsync-manager bot added the kind/Feature New feature or request label Jun 23, 2022
@stale
Copy link

stale bot commented Jul 18, 2023

This has been marked as stale because it is unassigned, and has not had recent activity. It will be closed after 21 days if no further activity occurs. If this should never go stale, please add the evergreen label, or request that it be added.

@stale stale bot added the stale label Jul 18, 2023
@edgarrmondragon
Copy link
Collaborator

Still relevant

@edgarrmondragon
Copy link
Collaborator

Closed by #2156

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants