Skip to content

Commit

Permalink
Hypercontext -> nfrasser
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrasser committed Nov 19, 2024
1 parent fb3ffea commit 503a4f8
Show file tree
Hide file tree
Showing 28 changed files with 83 additions and 81 deletions.
32 changes: 16 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

**Note:** This guide is a work in progress. Feel free to [submit an issue](https://github.com/Hypercontext/linkifyjs/issues/new) if anything is confusing or unclear.
**Note:** This guide is a work in progress. Feel free to [submit an issue](https://github.com/nfrasser/linkifyjs/issues/new) if anything is confusing or unclear.

## How linkify works

Expand All @@ -14,19 +14,19 @@ The second stage, the parser, takes this array of tokens and aggregates them int

A multitoken is either a link or not a link. Core linkify comes with these multitokens

* **`Text`** is plain text (that contains no linkable entities)
* **`Nl`** represents a single newline character
* **`Email`** email address
* **`URL`**
- **`Text`** is plain text (that contains no linkable entities)
- **`Nl`** represents a single newline character
- **`Email`** email address
- **`URL`**

The latter two are converted to links. `Nl` is in some cases converted to a `<br>` HTML tag.

You can use the Token class system to [create plugins](#building-plugins).

## Style

* ES6 Syntax (except tests for now)
* Hard tabs with a width of 4 characters
- ES6 Syntax (except tests for now)
- Hard tabs with a width of 4 characters

Keep your changes consistent with what's already there.

Expand Down Expand Up @@ -56,22 +56,22 @@ This transpiles ES6 to ES5 (via [Babel](http://babeljs.io/)) from `src/` into `d

These tools are used for testing linkify:

* [Mocha](https://mochajs.org/) is our primary test case framework
* [ESLint](https://eslint.org) for code linting
* [Istanbul](https://istanbul.js.org/) for code coverage analysis
* [Karma](http://karma-runner.github.io/) is our browser test runner
* [BrowserStack](https://www.browserstack.com) for cross-browser testing
- [Mocha](https://mochajs.org/) is our primary test case framework
- [ESLint](https://eslint.org) for code linting
- [Istanbul](https://istanbul.js.org/) for code coverage analysis
- [Karma](http://karma-runner.github.io/) is our browser test runner
- [BrowserStack](https://www.browserstack.com) for cross-browser testing

These are all configured to run in npm scripts. Tasks `npm test` and `npm run lint` are the most basic you can run. Other tasks include:

* `npm run build` converts the `src` ES source code into browser- and Node.js- compatible JavaScript. It also outputs TypeScript definitions.
* `npm run clean` removes all generated files
* `npm run dist` cleans, builds and copies the final browser distribution bundle into the root `dist` directory
- `npm run build` converts the `src` ES source code into browser- and Node.js- compatible JavaScript. It also outputs TypeScript definitions.
- `npm run clean` removes all generated files
- `npm run dist` cleans, builds and copies the final browser distribution bundle into the root `dist` directory

### Building plugins

**Caution:** The plugin development API is in its very early stages and only supports very basic plugins. Updated features, APIs, and docs are in the works.

Check out the sample [Hashtag plugin](https://github.com/Hypercontext/linkifyjs/blob/main/packages/linkify-plugin-hashtag/src/hashtag.js) for an example. Check out the [Keyword plugin](https://github.com/Hypercontext/linkifyjs/blob/main/packages/linkify-plugin-keyword/src/keyword.js) for more advanced usage.
Check out the sample [Hashtag plugin](https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-hashtag/src/hashtag.js) for an example. Check out the [Keyword plugin](https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-keyword/src/keyword.js) for more advanced usage.

Register a new plugin with [`linkify.registerPlugin()`](https://linkify.js.org/docs/linkifyjs.html#linkifyregisterplugin-name-plugin).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Linkify

[![npm version](https://badge.fury.io/js/linkifyjs.svg)](https://www.npmjs.com/package/linkifyjs)
[![CI](https://github.com/Hypercontext/linkifyjs/actions/workflows/ci.yml/badge.svg)](https://github.com/Hypercontext/linkifyjs/actions/workflows/ci.yml)
[![CI](https://github.com/nfrasser/linkifyjs/actions/workflows/ci.yml/badge.svg)](https://github.com/nfrasser/linkifyjs/actions/workflows/ci.yml)
[![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=ZVZXNFhhQ044a01nQStVeWJXSng1b01MTWFpZlZRZVg1WnAvdE9aVE9LVT0tLWZpekx6ZHUrZ2E0dDRHMDZRMnJNQlE9PQ==--4d91db279fbd0475f8d8e4b221b5a4c1e0c6a76e)](https://automate.browserstack.com/public-build/ZVZXNFhhQ044a01nQStVeWJXSng1b01MTWFpZlZRZVg1WnAvdE9aVE9LVT0tLWZpekx6ZHUrZ2E0dDRHMDZRMnJNQlE9PQ==--4d91db279fbd0475f8d8e4b221b5a4c1e0c6a76e)
[![Coverage Status](https://coveralls.io/repos/github/Hypercontext/linkifyjs/badge.svg?branch=main)](https://coveralls.io/github/Hypercontext/linkifyjs?branch=main)
[![Coverage Status](https://coveralls.io/repos/github/nfrasser/linkifyjs/badge.svg?branch=main)](https://coveralls.io/github/nfrasser/linkifyjs?branch=main)

Linkify is a JavaScript plugin. Use Linkify to find links in plain-text and
convert them to HTML &lt;a&gt; tags. It automatically highlights URLs,
Expand Down Expand Up @@ -40,7 +40,7 @@ convert them to HTML &lt;a&gt; tags. It automatically highlights URLs,

[View full documentation](https://linkify.js.org/docs/).

Download the [latest release](https://github.com/Hypercontext/linkifyjs/releases) for direct use in the browser, or install via [NPM](https://www.npmjs.com/):
Download the [latest release](https://github.com/nfrasser/linkifyjs/releases) for direct use in the browser, or install via [NPM](https://www.npmjs.com/):

```
npm install linkifyjs linkify-html
Expand Down Expand Up @@ -150,20 +150,20 @@ supported.

## Downloads

Download the [**latest release**](https://github.com/Hypercontext/linkifyjs/releases)
Download the [**latest release**](https://github.com/nfrasser/linkifyjs/releases)

## API Documentation

View full documentation at [linkify.js.org/docs](https://linkify.js.org/docs/)

## Contributing

Check out [CONTRIBUTING.md](https://github.com/Hypercontext/linkifyjs/blob/main/CONTRIBUTING.md).
Check out [CONTRIBUTING.md](https://github.com/nfrasser/linkifyjs/blob/main/CONTRIBUTING.md).

## License

MIT

## Authors

Linkify is made with ❤️ by [Hypercontext](https://hypercontext.com/) and [@nfrasser](https://github.com/nfrasser)
Linkify is made with ❤️ by [@nfrasser](https://github.com/nfrasser)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Intelligent link recognition, made easy",
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git"
"url": "git+https://github.com/nfrasser/linkifyjs.git"
},
"scripts": {
"build": "npm run build --workspaces",
Expand All @@ -26,7 +26,7 @@
"test:ci2": "karma start test/ci2.conf.js --single-run",
"tlds": "node tasks/update-tlds.js"
},
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"devDependencies": {
"@babel/core": "^7.13.10",
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-element/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-element/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-element"
},
"keywords": [
Expand All @@ -23,10 +23,10 @@
"email",
"browser"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-html/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-html/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-html"
},
"keywords": [
Expand All @@ -23,10 +23,10 @@
"url",
"email"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-jquery/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-jquery/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-jquery"
},
"keywords": [
Expand All @@ -24,10 +24,10 @@
"jquery",
"browser"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-plugin-hashtag/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-plugin-hashtag/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-plugin-hashtag"
},
"keywords": [
Expand All @@ -22,10 +22,10 @@
"url",
"email"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-plugin-ip/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-plugin-ip/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-plugin-ip"
},
"keywords": [
Expand All @@ -25,10 +25,10 @@
"ipv4",
"ipv6"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-plugin-keyword/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-plugin-keyword/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-plugin-keyword"
},
"keywords": [
Expand All @@ -23,10 +23,10 @@
"email",
"keyword"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-plugin-mention/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-plugin-mention/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-plugin-mention"
},
"keywords": [
Expand All @@ -22,10 +22,10 @@
"url",
"email"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-plugin-ticket/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-plugin-ticket/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-plugin-ticket"
},
"keywords": [
Expand All @@ -22,10 +22,10 @@
"url",
"email"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-plugin-ticket/src/ticket.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const TicketToken = createTokenClass('ticket', { isLink: true });
* @type {import('linkifyjs').Plugin}
*/
export default function ticket({ scanner, parser }) {
// TODO: Add cross-repo style tickets? e.g., Hypercontext/linkifyjs#42
// TODO: Add cross-repo style tickets? e.g., nfrasser/linkifyjs#42
// Is that even feasible?
const { POUND, groups } = scanner.tokens;

Expand Down
2 changes: 1 addition & 1 deletion packages/linkify-react/LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021 SoapBox Innovations Inc.
Copyright (c) 2024 Nick Frasser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions packages/linkify-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Hypercontext/linkifyjs.git",
"url": "git+https://github.com/nfrasser/linkifyjs.git",
"directory": "packages/linkify-react"
},
"keywords": [
Expand All @@ -23,10 +23,10 @@
"email",
"react"
],
"author": "Hypercontext",
"author": "Nick Frasser (https://nfrasser.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Hypercontext/linkifyjs/issues"
"url": "https://github.com/nfrasser/linkifyjs/issues"
},
"homepage": "https://linkify.js.org",
"peerDependencies": {
Expand Down
Loading

0 comments on commit 503a4f8

Please sign in to comment.