@sourcegraph/codeintellify

v7.4.0

Adds code intelligence to code views on the web

NPM

README

GitHub

MIT

Latest version published 2 months ago

    npm install @sourcegraph/codeintellify

We couldn't find any similar packages Browse all packages

Package Health Score

48 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Sustainable

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Popularity

Limited

Weekly Downloads (255)

Dependents: 2
GitHub Stars: 57
Forks: 8
Contributors: 20

Direct Usage Popularity

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

Based on project statistics from the GitHub repository for the npm package @sourcegraph/codeintellify, we found that it has been starred 57 times, and that 2 other projects in 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

Popular

Version

Release Date

12/2018

04/2020

07/2020

11/2021

11/2021

Direct Vulnerabilities

Popular

Indirect Vulnerabilities

Popular

License Risk

Popular

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

License

MIT

Security Policy

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

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

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

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

archived

Commit Frequency

Open Issues: 11
Open PR: 36
Last Release: 2 months ago
Last Commit: 2 months 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 Inactive.

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

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the @sourcegraph/codeintellify repository, this is possibly a sign for a growing and inviting community.

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: 4 years
Dependencies: 6 Direct
Versions: 82
Install Size: 272 kB
Dist-tags: 1
# of Files: 33
Maintainers: 16
TS Typings: Yes

@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.

Not sure how to use @sourcegraph/codeintellify?

To help you get started, we've collected the most common ways that @sourcegraph/codeintellify is being used within popular public projects.

sourcegraph / sourcegraph / packages / webapp / src / repo / compare / FileDiffHunks.tsx View on Github

constructor(props: Props) {
        super(props)
        this.state = {
            hoverOverlayIsFixed: false,
            clickedGoToDefinition: false,
            mouseIsMoving: false,
        }

        this.subscriptions.add(
            this.props.hoverifier.hoverify({
                dom: diffDomFunctions,
                positionEvents: this.codeElements.pipe(
                    filter(isDefined),
                    findPositionsFromEvents(diffDomFunctions)
                ),
                positionJumps: NEVER, // TODO support diff URLs
                resolveContext: hoveredToken => {
                    // if part is undefined, it doesn't matter whether we chose head or base, the line stayed the same
                    const { repoPath, rev, filePath, commitID } = this.props[hoveredToken.part || 'head']
                    // If a hover or go-to-definition was invoked on this part, we know the file path must exist
                    return { repoPath, filePath: filePath!, rev, commitID }
                },
            })
        )
    }

View more ways to use @sourcegraph/codeintellify

CodeIntellify

build

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.

@sourcegraph/codeintellify dependencies

@sourcegraph/event-positions @sourcegraph/extension-api-types lodash rxjs sourcegraph ts-key-enum

FAQs

What is @sourcegraph/codeintellify?

Adds code intelligence to code views on the web. Visit Snyk Advisor to see a full health score report for @sourcegraph/codeintellify, including popularity, security, maintenance & community analysis.

Is @sourcegraph/codeintellify popular?

The npm package @sourcegraph/codeintellify receives a total of 255 weekly downloads. As such, @sourcegraph/codeintellify popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @sourcegraph/codeintellify well maintained?

We found indications that @sourcegraph/codeintellify is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @sourcegraph/codeintellify safe to use?

The npm package @sourcegraph/codeintellify was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 15 January-2022, at 20:10 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Secure Your Project

Weekly Downloads (255)

Direct Usage Popularity

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risk

Commit Frequency

Embed Package Health Score Badge

Not sure how to use @sourcegraph/codeintellify?

CodeIntellify

What it does

Usage

Development

Releases

Glossary

@sourcegraph/codeintellify dependencies

FAQs

What is @sourcegraph/codeintellify?

Is @sourcegraph/codeintellify popular?

Is @sourcegraph/codeintellify well maintained?

Is @sourcegraph/codeintellify safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues