Skip to content

docs(fli-js): import as "fli" via alias install#188

Closed
punitarani wants to merge 1 commit into
mainfrom
claude/readme-fli-import-alias
Closed

docs(fli-js): import as "fli" via alias install#188
punitarani wants to merge 1 commit into
mainfrom
claude/readme-fli-import-alias

Conversation

@punitarani

@punitarani punitarani commented May 24, 2026

Copy link
Copy Markdown
Owner

Summary

Make the documented usage import … from "fli" (instead of from "@punitarani/fli") while keeping the published name @punitarani/fli.

Why an alias install

In Node/npm the import specifier is the installed package's name. The unscoped fli name is owned by another npm account, so we can't publish under it, and there's no package.json field that lets consumers import a package under a different name than it's installed as. The one supported way to get import … from "fli" is an install-time alias, which all package managers support:

npm i fli@npm:@punitarani/fli

This installs the scoped package under the local name fli in node_modules, so the bare "fli" specifier resolves.

Changes (fli-js/README.md only)

  • Install section now shows the alias install for npm/pnpm/yarn/bun, with a short note explaining what it does and offering the plain scoped install (@punitarani/fli + from "@punitarani/fli") as an alternative.
  • The Quick start, SearchDates, and Client examples now import … from "fli".

No source/package.json changes — the publish name stays @punitarani/fli; this is purely how consumers are guided to install and import.

https://claude.ai/code/session_01R2vZihmSWV2wvRawjF4Gjo


Generated by Claude Code

Greptile Summary

This PR updates fli-js/README.md to guide consumers to install the scoped package @punitarani/fli under the local alias fli, enabling cleaner import … from "fli" syntax. No source files or package.json are changed.

  • Install section now shows pkg@npm:@punitarani/fli alias commands for npm, pnpm, yarn, and bun, with a blockquote explaining the mechanism and offering the plain scoped install as an alternative.
  • All three import examples (Quick start, Date-range search, HTTP/proxy) are updated from "@punitarani/fli" to "fli" to match the aliased install.

Confidence Score: 5/5

Documentation-only change with no source or package.json modifications; safe to merge.

The change touches only the README. The alias install pattern (pkg@npm:scope/pkg) is natively supported by npm, pnpm, yarn, and bun, so the documented commands are correct. All updated import examples are consistent with the aliased install. The alternative scoped-name path is preserved and clearly explained.

No files require special attention.

Important Files Changed

Filename Overview
fli-js/README.md Documentation-only change: rewrites the install section to use npm alias syntax and updates all import examples from @punitarani/fli to fli.

Sequence Diagram

sequenceDiagram
    participant User
    participant npm/pnpm/yarn/bun
    participant node_modules

    User->>npm/pnpm/yarn/bun: "install fli@npm:@punitarani/fli"
    npm/pnpm/yarn/bun->>node_modules: "place @punitarani/fli files under fli/ alias"
    note over node_modules: node_modules/fli/ → @punitarani/fli contents

    User->>User: "import { SearchFlights } from "fli""
    User->>node_modules: resolve specifier "fli"
    node_modules-->>User: "returns @punitarani/fli exports"
Loading

Reviews (1): Last reviewed commit: "docs(fli-js): import as "fli" via alias ..." | Re-trigger Greptile

The package is published as @punitarani/fli (the unscoped `fli` name is
owned by another npm account). To let consumers write
`import … from "fli"`, document the install-time alias
`npm i fli@npm:@punitarani/fli`, which installs the scoped package under
the local name `fli` so the bare `"fli"` specifier resolves. Update the
Quick start / SearchDates / Client examples to import from "fli", and note
the plain scoped alternative for anyone who prefers it.
@github-actions

Copy link
Copy Markdown
Contributor

Test Results

    5 files  ±0     56 suites  ±0   49s ⏱️ -11s
  659 tests ±0    659 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 861 runs  ±0  1 861 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit f3e2f1c. ± Comparison against base commit 88d9d1d.

Copy link
Copy Markdown
Owner Author

Superseded by #189, which renames the package to the unscoped fli-js — so install and import are both the plain fli-js (no alias needed). Closing this in favor of that approach.


Generated by Claude Code

@punitarani punitarani closed this May 24, 2026
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 this pull request may close these issues.

2 participants