@sourcegraph/codeintellify

v7.2.0

Adds code intelligence to code views on the web

NPM

README

GitHub

Website

MIT

Latest version published 2 months ago

    npm install @sourcegraph/codeintellify

We couldn't find any similar packages Browse all packages

Package Health Score

79 / 100

Popularity
Small
Maintenance
Healthy
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Small

Weekly Downloads (4,864)

Dependents: 2
GitHub Stars: 49
Forks: 7
Contributors: 10

The npm package @sourcegraph/codeintellify receives a total of 4,864 downloads a week. As such, we scored @sourcegraph/codeintellify popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @sourcegraph/codeintellify, we found that it has been starred 49 times, and that 2 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

5.0.2

5.1.0

6.4.0

7.1.0

7.2.0

Indirect Vulnerabilities

5.0.2

5.1.0

6.4.0

7.1.0

7.2.0

License Risks

5.0.2

5.1.0

6.4.0

7.1.0

7.2.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like @sourcegraph/codeintellify is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test @sourcegraph/codeintellify

Fix it in your project with Snyk!

Maintenance

Healthy

Commit Frequency

Open Issues: 10
Merged PR: 246
Open PR: 15
Last Commit: 15 days ago

Further analysis of the maintenance status of @sourcegraph/codeintellify based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @sourcegraph/codeintellify demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 10
Funding: No
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @sourcegraph/codeintellify is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 6 Direct / 7 Total
Versions: 76
Install Size: 264 kB
Dist-tags: 1
# of Files: 33
Maintainers: 14
TS Typings: Yes

We detected a total of 7 direct & transitive dependencies for @sourcegraph/codeintellify. See the full dependency tree of @sourcegraph/codeintellify

@sourcegraph/codeintellify has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

CodeIntellify

This library manages all of the inputs (mouse/keyboard events, location changes, hover information, and hover actions) necessary to display hover tooltips on with a code view. All together, this makes it easier to add code intelligence to code views on the web. Used in Sourcegraph.

What it does

Listens to hover and click events on the code view
On mouse hovers, determines the line+column position, performs a hover request, and renders it in a nice tooltip overlay at the token
Shows actions in the hover
When clicking a token, pins the tooltip to that token
Highlights the hovered token

You need to provide your own UI component (referred to as the HoverOverlay) that actually displays this information and exposes these actions to the user.

Usage

Call createHoverifier() to create a Hoverifier object (there should only be one on the page, to have only one HoverOverlay shown).
The Hoverifier exposes an Observable hoverStateUpdates that a consumer can subscribe to, which emits all data needed to render the HoverOverlay
For each code view on the page, call hoverifier.hoverify(), passing the position events coming from findPositionsFromEvents().
hoverify() returns a Subscription that will "unhoverify" the code view again if unsubscribed from

Development

yarn
yarn test

# Helpful options:
yarn test -- --single-run      # Don't rerun on changes
yarn test -- --browsers Chrome # Only run in Chrome

Development is done by running tests. Karma is used to run Mocha tests in the browser. You can debug by opening https://localhost:9876/debug.html in a browser while the test running is active. The tests will rerun automatically when files are changed.

You can run specific tests by adding .only to describe or it calls.

Releases

Releases are done automatically in CI when commits are merged into master by analyzing Conventional Commit Messages. After running yarn, commit messages will be linted automatically when committing. You may have to rebase a branch before merging to ensure it has a proper commit history.

Glossary

Term	Definition
Code view	The DOM element that contains all the line elements
Line number element	The DOM element that contains the line number label for that line
Code element	The DOM element that contains the code for one line
Diff part	The part of the diff, either base, head or both (if the line didn't change). Each line belongs to one diff part, and therefor to a different commit ID and potentially different file path.
Hover overlay	Also called tooltip
hoverify	To attach all the listeners needed to a code view so that it will display overlay on hovers and clicks.
unhoverify	To unsubscribe from the Subscription returned by `hoverifier.hoverify()`. Removes all event listeners from the code view again and hides the hover overlay if it was triggered by the unhoverified code view.