Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pawfa/ts-package-scope-plugin
TypeScript Language Service Plugin for creating package scope.
https://github.com/pawfa/ts-package-scope-plugin
encapsulation modules package plugin scope typescript
Last synced: 3 days ago
JSON representation
TypeScript Language Service Plugin for creating package scope.
- Host: GitHub
- URL: https://github.com/pawfa/ts-package-scope-plugin
- Owner: pawfa
- Created: 2022-05-10T17:41:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-28T07:53:06.000Z (over 2 years ago)
- Last Synced: 2024-11-03T22:49:25.044Z (13 days ago)
- Topics: encapsulation, modules, package, plugin, scope, typescript
- Language: TypeScript
- Homepage:
- Size: 262 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/ts-package-scope-plugin)
[](https://github.com/pawfa/ts-package-scope-plugin/actions)
[](https://snyk.io/test/github/pawfa/ts-package-scope-plugin?targetFile=package.json)
# ts-package-scope-plugin
TypeScript Language Service Plugin for creating package scopes using dir names and JS Docs.
It provides IntelliSense for VS Code and error reporting using TypeScript TSServer.
## Installation and usage
Install package:
`yarn add -D ts-package-scope-plugin` or `npm i --save-dev ts-package-scope-plugin`
Update `tsconfig.json`:
```json
{
"compilerOptions": {
"plugins": [
{
"name": "ts-package-scope-plugin"
}
]
}
}
```
_VS Code users_
Run command _TypeScript: Select TypeScript version_ and choose _Use workspace version_:
## Configuration
By default, plugin will analyse the same files as the TypeScript compiler in your project. You can override this behavior by using `include` property:
```
{
"compilerOptions": {
"plugins": [
{
"name": "ts-package-scope-plugin",
"options": {
"include": ["./src/**/*"]
}
}
]
}
}
```
### Package scope
There are two ways to make module package scoped. Using suffix/prefix in folder name or setting plugin option with specific folder names.
#### 1. `package` prefix/suffix
To make file package scoped using prefix/suffix it needs to be placed in folder with `package` in its name separated with dot ex. `package.` or `.package`:
```
project
│ README.md
│ file001.txt
│
└───package.interface
│ │ api.ts
│
└───package.domain
│ client.ts
```
#### 2. `packageNames` option
To make file package scoped using specific folder names, they have to be listed as an array in tsconfig.json plugin option:
```
{
"compilerOptions": {
"plugins": [
{
"name": "ts-package-scope-plugin",
"options": {
"packageNames": ["core", "domain"]
}
}
]
}
}
```
When you import file from one package into another, IDE will show a TypeScript error.
#### Public scope
To make file available from other packages set its scope to public using JS Doc tag at the top of the file:
```javascript
/** @package-scope public **/
import { Helper } from "./helpers";
export function getClient() {}
```
#### IntelliSense filtering (only for VS Code)
By default, files which are not available for current package will be removed from intellisense suggestions.
To turn on or off this feature you can use `intelliSense` option in tsconfig.json:
```json
{
"compilerOptions": {
"plugins": [
{
"name": "ts-package-scope-plugin",
"options": {
"intelliSense": false
}
}
]
}
}
```