@google-automations/git-file-utils

v2.0.0

Utilities for github file operation For more information about how to use this package see README

Latest version published 1 year ago

License: Apache-2.0

NPM

GitHub

Package Health Score

72 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.0	\|	09/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.6	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	08/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	08/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (209,882)

GitHub Stars: 619
Forks: 122
Contributors: 70

Direct Usage Popularity

The npm package @google-automations/git-file-utils receives a total of 209,882 downloads a week. As such, we scored @google-automations/git-file-utils popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @google-automations/git-file-utils, we found that it has been starred 619 times.

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

Community

Active

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

With more than 10 contributors for the @google-automations/git-file-utils repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 70
Open PR: 14
Last Release: 1 year ago
Last Commit: 26 days ago

Further analysis of the maintenance status of @google-automations/git-file-utils based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @google-automations/git-file-utils is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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.

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

Package

Node.js Compatibility: >= 18

Age: 2 years
Dependencies: 3 Direct
Versions: 11
Install Size: 46.1 kB
Dist-tags: 1
# of Files: 6
Maintainers: 1
TS Typings: No

@google-automations/git-file-utils 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.

Readme

git-file-utils

This is a small library for handling git files. Currently it only provides RepositoryFileCache which is a read-through cache for a single branch. Because this library uses GIt Data API, it can fetch files up to 100 MB of size.

Install

npm i @google-automations/git-file-utils

Fetch a file

import {Octokit} from '@octokit/rest';
import {
  FileNotFoundError,
  RepositoryFileCache
} from '@google-automations/git-file-utils';

const octokit = new Octokit();
const cache = new RepositoryFileCache(
  octokit,
  {
    owner: "googleapis",
    repo: "repo-automation-bots",
  });
try {
  const contents = await cache.getFileContents("README.md", "main");
  console.log(`content: ${contents.parsedContent}`);
} catch (e) {
  if (e instanceof FileNotFoundError) {
    console.log(`file not found`);
  } else {
    // rethrow
    throw e;
  }
}

@google-automations/git-file-utils dependencies

@octokit/rest @octokit/types minimatch

@google-automations/git-file-utils development dependencies

@types/chai @types/minimatch @types/mocha @types/node @types/sinon c8 chai cross-env dotenv gts mocha nock sinon snap-shot-it typescript

FAQs

What is @google-automations/git-file-utils?

Utilities for github file operation. Visit Snyk Advisor to see a full health score report for @google-automations/git-file-utils, including popularity, security, maintenance & community analysis.

Is @google-automations/git-file-utils popular?

The npm package @google-automations/git-file-utils receives a total of 209,882 weekly downloads. As such, @google-automations/git-file-utils popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @google-automations/git-file-utils well maintained?

We found indications that @google-automations/git-file-utils is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @google-automations/git-file-utils safe to use?

The npm package @google-automations/git-file-utils 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 8 November-2024, at 10:54 (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