Title: Suggestion: making exports visible only to the same directory with JSDoc @package tag · Issue #41425 · microsoft/TypeScript · GitHub
Open Graph Title: Suggestion: making exports visible only to the same directory with JSDoc @package tag · Issue #41425 · microsoft/TypeScript
X Title: Suggestion: making exports visible only to the same directory with JSDoc @package tag · Issue #41425 · microsoft/TypeScript
Description: Search Terms JSDoc package directory package-private Suggestion If an export is annotated with @package, that export is visible only to files in the same directory. I can think of two levels of @package support: a soft one would remove t...
Open Graph Description: Search Terms JSDoc package directory package-private Suggestion If an export is annotated with @package, that export is visible only to files in the same directory. I can think of two levels of @pa...
X Description: Search Terms JSDoc package directory package-private Suggestion If an export is annotated with @package, that export is visible only to files in the same directory. I can think of two levels of @pa...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/41425
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Suggestion: making exports visible only to the same directory with JSDoc @package tag","articleBody":"## Search Terms\r\n\r\nJSDoc package directory package-private\r\n\r\n## Suggestion\r\n\r\nIf an export is annotated with `@package`, that export is visible only to files in the same directory.\r\n\r\nI can think of two levels of `@package` support: a soft one would remove these exports from auto completion if not visible. A hard one would also emit a compile error.\r\n\r\nSee also: [Use JSDoc: @package](https://jsdoc.app/tags-package.html)\r\n\r\n\r\n## Use Cases\r\n\r\nWe organize source code using directory structure. We often make exports that are meant to be referenced only by sibling modules. However, JavaScript/TypeScript has no idea of scoping based on file system, so we are free to import such \"local\" exports everywhere. TypeScript could help us do file system-based scoping.\r\n\r\n## Examples\r\n\r\n```ts\r\n// ----- src/foo/bar.ts\r\n/**\r\n * @package\r\n */\r\nexport fooBar = \"fooBar\";\r\n\r\n// ----- src/foo/index.ts\r\n// Can import fooBar from \"./bar\"\r\nimport { fooBar } from \"./bar\";\r\n\r\n// ----- index.ts\r\n// CANNOT import fooBar from \"./foo/bar\"\r\nimport { fooBar } from \"./foo/bar\";\r\n```\r\n\r\n\r\n## Checklist\r\n\r\nMy suggestion meets these guidelines:\r\n\r\n* [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n* [x] This wouldn't change the runtime behavior of existing JavaScript code\r\n* [x] This could be implemented without emitting different JS based on the types of the expressions\r\n* [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)\r\n* [x] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).\r\n","author":{"url":"https://github.com/uhyo","@type":"Person","name":"uhyo"},"datePublished":"2020-11-06T02:52:50Z","url":"https://github.com/microsoft/TypeScript/issues/41425"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:e0000a48-d903-03f5-9fbe-9be620f27ee6 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 91CA:FC5BE:553FCD:730AAA:6B00D13B |
| html-safe-nonce | 48e4d5d5960e09f266df7d0553eb009154e6fcf7f3dabe0243268df4dd65a752 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MUNBOkZDNUJFOjU1M0ZDRDo3MzBBQUE6NkIwMEQxM0IiLCJ2aXNpdG9yX2lkIjoiMTQyNDQ1MDUxOTk3MTE4OTA1MiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 7f14b00cbb07e32d43c5c266c8d6e6256e1ea58e6ae2f8d7a4a980555cd27747 |
| hovercard-subject-tag | issue:737414685 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/41425/issue_layout |
| twitter:image | https://opengraph.githubassets.com/977290d3bc7bde90e2e90c8b775ea5aa704bc599bc69c9b643e124bd4128afa9/microsoft/TypeScript/issues/41425 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/977290d3bc7bde90e2e90c8b775ea5aa704bc599bc69c9b643e124bd4128afa9/microsoft/TypeScript/issues/41425 |
| og:image:alt | Search Terms JSDoc package directory package-private Suggestion If an export is annotated with @package, that export is visible only to files in the same directory. I can think of two levels of @pa... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | uhyo |
| hostname | github.com |
| expected-hostname | github.com |
| None | 85bbdfe2b6ba16e234513bc6ceff5d848ef8449820c900692a2b4e67061931e5 |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 20929025 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 20929025 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 4943239a6d2c591325dad6e5c313e1cafda877f6 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width