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

Explicitly include libraries (opposite of stIgnore) #601

Open
cornerman opened this issue Jan 29, 2024 · 0 comments · May be fixed by #632
Open

Explicitly include libraries (opposite of stIgnore) #601

cornerman opened this issue Jan 29, 2024 · 0 comments · May be fixed by #632

Comments

@cornerman
Copy link

cornerman commented Jan 29, 2024

Would you be open to a PR that adds a setting to explicitly include dependencies?

Right now, I have to stIgnore every dependency that should not have a scalablytyped facade. But in order to keep the build.sbt more expressive, I would actually like to specify the packages that need a scalablytyped facade. Because otherwise I can only understand it together with the package.json.

It could look like this (open for other name suggestions):

stIncludeExplicit := Some(List(
  "packageA",
  "packageB"
))

There are a few cases to handle though:

  • Settings stIgnore and stIncludeExplicit would not compose well and should not be used together.
  • What should happen if the dependency is not in the package.json? I would actually like it to fail.
cornerman added a commit to cornerman/Converter that referenced this issue Jun 8, 2024
If you only want to generate scalablytyped facedes for a few js depdendencies, you currently have to maintain an ignore list in the build.sbt file.

In order to make this more explicit and easier to maintain, this PR introduces a new option `stExplicitInclude`, which allows to explicitly select the libraries, you want to process. All others are automatically ignored.

Usage:
```
// is None per default
stExplicitInclude := Some(List("packageA", "packageB"))
```

fixes ScalablyTyped#601
@cornerman cornerman linked a pull request Jun 8, 2024 that will close this issue
cornerman added a commit to cornerman/Converter that referenced this issue Jun 8, 2024
If you only want to generate ScalablyTyped facades for a few js dependencies, you currently have to maintain an ignore list in the build.sbt file.

In order to make this more explicit and easier to maintain, this PR introduces a new option `stExplicitInclude`, which allows to explicitly select the libraries, you want to process. All others are automatically ignored.

Usage:
```
// is None per default
stExplicitInclude := Some(List("packageA", "packageB"))
```

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

Successfully merging a pull request may close this issue.

1 participant