Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose guidelines in NPM package #4900

Closed
2 of 5 tasks
ericcornelissen opened this issue Jan 31, 2021 · 3 comments · Fixed by #5342
Closed
2 of 5 tasks

Expose guidelines in NPM package #4900

ericcornelissen opened this issue Jan 31, 2021 · 3 comments · Fixed by #5342
Assignees
Labels
package Pull requests or issues that affect the NPM package

Comments

@ericcornelissen
Copy link
Contributor

ericcornelissen commented Jan 31, 2021

Kind of issue

  • Improvement
  • Bug
  • Other, namely:

This issue concerns

  • The NPM Package
  • The Packagist Package

Description

With #2846 being merged since a few releases, I think it is time to consider whether or not the "guidelines" field should be exposed by the NPM package (beyond it being present in the _data/simple-icons.json file).

That is, in terms of the Node Usage section of the README:

  const simpleIcons = require('simple-icons');

  console.log(simpleIcons.get('Simple Icons'));

  /*
  {
      title: 'Simple Icons',
      slug: 'simpleicons',
      hex: '111111',
      source: 'https://simpleicons.org/',
+     guidelines: '[THE GUIDELINES URL]' or ???, 
      svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>',
      path: 'M12 12v-1.5c-2.484 ...'
  }
  */

The main question being - if we decide to include this field - what its value should be if there are no guidelines for a brand. I think we are fine if the field is omitted, but that may be too shortsighted 🙃

@ericcornelissen ericcornelissen added the package Pull requests or issues that affect the NPM package label Jan 31, 2021
@PeterShaggyNoble

This comment has been minimized.

@ericcornelissen

This comment has been minimized.

@ericcornelissen ericcornelissen mentioned this issue Feb 3, 2021
7 tasks
@ericcornelissen
Copy link
Contributor Author

Small remark I want to add here: this would require us to update the DefinitelyTyped types for simple-icons.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package Pull requests or issues that affect the NPM package
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants