azu / tweet-truncator

Truncate contents to 140 chars for Twitter/Tweets

tweet-truncator

Truncate contents to 280 chars for tweeting.

• twitter-text-js

Installation

npm install tweet-truncator

Usage

truncate(content, [options])

import { truncate } from "tweet-truncator";
const contents = {
    title: "tweet-truncator",
    url: "https://github.com/azu/tweet-truncator",
    desc: "Truncate contents to 140 chars.",
    quote: "quote",
    tags: ["#twitter", "JavaScript"]
};
const options = {
    defaultPrefix: "See:",
    template: '%desc% "%title%" %url% %tags%',
    // maxLength: 280
};
const result = truncate(contents, options);
console.log(result);
/*
Truncate contents to 140 chars. "tweet-truncator" https://github.com/azu/tweet-truncator #twitter #JavaScript
*/

See example/

TweetTruncator

TweetTruncator is a core class of tweet-truncator.

const truncator = new TweetTruncator({
    defaultPrefix: "See:",
    template: `%desc% "%title%" %url% %tags%`
});
const contents = {
    title: "TITLE",
    url: "https://github.com/twitter/twitter-text",
    desc: "",
    quote: "quote",
    tags: []
};
const overLength = 10;// it means that remove 10 chars from contents.
var result = truncator.truncateStatus(contents, overLength);

Tests

npm test

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT

Thanks to Tombfix.

tweet-truncator's Issues

Explicitly undefined input causes an error

When inputting content value is undefined, TweetTruncator throws a runtime error.

https://github.com/azu/tweet-truncator/blob/master/src/tweet-truncator.ts#L72

TypeError: Cannot read properties of undefined (reading 'length')

In my situation below, desc is typed as string or undefined. so contents["desc"] is undefined. On TypeScript definition, it is valid because foo?: string and foo: string | undefined are not distinguished commonly.

https://github.com/azu/tweet-truncator/blob/master/src/index.ts#L22

  // item.desc is string | undefined
  truncate(
    { desc: item.desc, title: item.title, url: item.url },
    {
      defaultPrefix: '🔖',
      template: '%desc% "%title%" %url%',
      truncatedOrder: ['title', 'desc'],
    },
  );

https://github.com/azu/tweet-truncator/blob/master/src/index.ts#L27-L34

    const fixedContents = {
        desc: "",
        quote: "",
        title: "",
        url: "",
        tags: [],
        ...contents
    };

Suggestion

• override with empty string if inputted value is nullish.

for example:

    const { desc, quote, title, url, tags, ...unknownContents} = contents;

    const fixedContents = {
        desc: desc ?? "",
        quote: quote ?? "",
        title: title ?? "",
        url: url ?? "",
        tags: tags ?? [],
        ...unknownContents
    };