@times-components/article-summary

v3.25.23

An article summary contains optional information about an article such as headline, summary, publication date, author and label. Some of these components are passed in as render props, and others are passed in as a config object, either containing props t For more information about how to use this package see README

Latest version published 20 days ago

License: BSD-3-Clause

NPM

GitHub

Package Health Score

87 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
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
3.25.23	\|	12/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.25.19	\|	11/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.24.83	\|	08/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.1	\|	08/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.23	\|	07/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

Security Policy

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

Small

Weekly Downloads (1,714)

GitHub Stars: 258
Forks: 42
Contributors: 120

Direct Usage Popularity

The npm package @times-components/article-summary receives a total of 1,714 downloads a week. As such, we scored @times-components/article-summary popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @times-components/article-summary, we found that it has been starred 258 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: No
Contributors: 120
Funding: No

A good and healthy external contribution signal for @times-components/article-summary project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like @times-components/article-summary is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 5
Open PR: 64
Last Release: 20 days ago
Last Commit: 20 days ago

Further analysis of the maintenance status of @times-components/article-summary based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @times-components/article-summary 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.

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: not defined

Age: 7 years
Dependencies: 10 Direct
Versions: 1.03K
Install Size: 288 kB
Dist-tags: 2
# of Files: 16
Maintainers: 3
TS Typings: No

@times-components/article-summary 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

Article Summary

An article summary contains optional information about an article such as headline, summary, publication date, author and label. Some of these components are passed in as render props, and others are passed in as a config object, either containing props to be passed on to the appropriate component, or an Abstract Syntax Tree ("AST") which a component can handle by itself.

Components with a config object of props

These components make up the core of an article summary and so, although not required, are made up of specific components.

date publication - article summary wraps the DatePublication component and simply passes on the date props it receives
label - article summary passes label props onto either ArticleLabel or VideoLabel

Components with a render prop

Components that can be specified by the consumer can be passed in as render props.

headline - ArticleSummaryHeadline lays out an accessible article headline
content - ArticleSummaryContent handles an AST, but is passed into the summary as a render prop

Components with an AST

byline - passes the given AST to ArticleByline or ArticleBylineWithLinks

Contributing

Please read CONTRIBUTING.md before contributing to this package

Running the code

Please see our main README.md to get the project running locally

Development

The code can be formatted and linted in accordance with the agreed standards.

yarn fmt
yarn lint

Testing

This package uses yarn (latest) to run unit tests on each platform with jest.

yarn test:web

Visit the official storybook to see our available article summary templates.

Future

We intend to roll out type checking (TypeScript) throughout the Times Components repo. The components that are allowed within article summary props will be controlled with TypeScript.

@times-components/article-summary dependencies

@times-components/article-byline @times-components/article-label @times-components/date-publication @times-components/markup @times-components/markup-forest @times-components/ts-components @times-components/ts-styleguide @times-components/utils @times-components/video-label prop-types

@times-components/article-summary development dependencies

@babel/core @times-components/eslint-config-thetimes @times-components/jest-configurator-web @times-components/jest-serializer @times-components/storybook @times-components/test-utils @times-components/webpack-configurator babel-jest babel-loader depcheck eslint jest prettier react react-dom react-test-renderer webpack

FAQs

What is @times-components/article-summary?

An article summary contains optional information about an article such as headline, summary, publication date, author a... Visit Snyk Advisor to see a full health score report for @times-components/article-summary, including popularity, security, maintenance & community analysis.

Is @times-components/article-summary popular?

The npm package @times-components/article-summary receives a total of 1,714 weekly downloads. As such, @times-components/article-summary popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @times-components/article-summary well maintained?

We found that @times-components/article-summary demonstrated a healthy version release cadence and project activity. It has a community of 120 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @times-components/article-summary safe to use?

The npm package @times-components/article-summary 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 4 December-2024, at 22:12 (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