abhijithvijayan / stargazed

📋 Creating your own Awesome List of GitHub stars!

stargazed

Creating your own Awesome List of GitHub Stars!

https://github.com/abhijithvijayan/awesome-stars

🙋‍♂️ Made by @abhijithvijayan

Donate: PayPal, Patreon

---

❤️ it? ⭐️ it on GitHub or Tweet about it.

Table of Contents

• Installation
• Usage
• FAQs
• Issues
  • 🐛 Bugs
• LICENSE

Installation

Ensure you have Node.js 10 or later installed. Then run the following:

npx stargazed [options]

Usage

$ stargazed --help

  Creating your own Awesome List of GitHub Stars!

  Options
    -u, --username TEXT    GitHub username
    -t, --token TEXT       GitHub token
    -s, --sort             sort by language
    -r, --repository TEXT  repository name
    -m, --message TEXT     commit message
    -w, --workflow         Setup GitHub Actions for Daily AutoUpdate
    -v, --version          Show the version and exit with code 0

  Examples
    $ stargazed --username abhijithvijayan --token "GITHUB-TOKEN" --repository "awesome-stars"  --sort --workflow
    $ stargazed -u "abhijithvijayan" -r "awesome-stars" -t "GITHUB-TOKEN" -m "COMMIT_MESSAGE" -s

Demo

• abhijithvijayan/awesome-stars

FAQs

Generate new token

Goto Personal access tokens

Why do I need a token

• For unauthenticated requests, the rate limit is 60 requests per hour. see Rate Limiting
• The token must be passed together when you want to automatically create the repository.

How can I automate the process after initial run

Use -w, --workflow flag to set up GitHub workflow that updates the repo at 00:30 everyday

stargazed -u "abhijithvijayan" -r "awesome-stars" -t "GITHUB-TOKEN" -s -w

Issues

Looking to contribute? Look for the Good First Issue label.

See contribution guidelines

🐛 Bugs

Please file an issue here for bugs, missing documentation, or unexpected behavior.

See Bugs

Linting Config

• Shared Eslint & Prettier Configuration - @abhijithvijayan/eslint-config

License

MIT © Abhijith Vijayan

stargazed's Issues

add CODE_OF_CONDUCT

with email [email protected]

Update check for global installation

As CLI has the template files within, it is better to notify user for the update if available.

https://github.com/zeit/update-check

Add kodiak bot config

For merging PRs after CI(WIP) tests passed

Kodiak bot

[Bug] Bundle size too high

The README.md file generated in development somehow is included in the npm pack ed file, which increases the build size.

This file is ignored using .gitignore yet it is attached with the publishing package

Disable linting the markdown file (template.md)

The markdown linter, applies linting automatically on the template.md file when applied a change and saved.

The VScode I use, really messes this up and output produced by CLI is then ruined.

If there is any config that disables this auto lint, it might be useful.

Set up CI

Set up CI for running tests & also running CLI on different Node.js LTS versions

Preferred Travis

replace npm badge with travis status badge

Use
[![Build Status](https://travis-ci.com/abhijithvijayan/stargazed.svg?branch=master)](https://travis-ci.com/abhijithvijayan/stargazed)

Features

Currently only the list is being fetched with the -u flag.

The rest of the flags does nothing for now.

They are to be worked on soon enough.

ADD contributing guidelines

Checklist

Add contributing guidelines

Expected Behavior

make sure to ask to obey by the code of conduct file #17
and to have good behaviour to other contributors

List out as tables for more clear view

Use stars and owners name along.

& resolving to & on markdown index links

See https://github.com/abhijithvijayan/awesome-stars/blob/master/README.md#L26

• Jupyter Notebook (10)

add issue template

a general useful template
that has comments inside it saying to attach screenshots possible and also to check if such issue exists before creating

Cannot read property 'login' of null error

I've been using this tool for past 2 months, but from few weeks, it's not working, I've been trying to debug things, but not able to figure it out the exact issue that's causing, would love to get it solved by you guys! Thanks! and I'm attaching the screenshot.

Checklist

• I checked that this is not an existing issue
• I gave clear steps to reproduce this issue

repo - https://github.com/abhisheknaiidu/nads

Make commit message for GitHub actions with timestamp

Like

Automated publish: Sat Jan 18 03:32:36 UTC 2020

This format

Maybe a hint for those who want to run and don't have a node (like me) but have a docker

docker run -it --rm -v `pwd`:/tmp/stargazed -w /tmp/stargazed node sh -c "npm install && npx stargazed -u "abhijithvijayan" -r "awesome-stars" -t "GITHUB-TOKEN" -s -w

Code Refactoring

Complexity of some functions are way over the best and top.

As a solution to that, code splitting is necessary to tackle this.

add unit tests

Checklist

• Initial barebone
• Add unit tests for the commands offered by the cli

add extension to eslint config file

As eslint recommends to use an extension to the config file used, renaming .eslintrc to .eslintrc.json seems a good idea.

Please comment here first and then proceed to PR.

Use babel npm package to transpile your ES6 to a commonjs target

export const validate = _options => {
^^^^^^

SyntaxError: Unexpected token export

Swap the order

To make it look like

sl. No | Name | Description | Author | Stars

Table view is broken

GitHub Action documentation

Checklist

• I checked that this is not an existing issue
• I gave clear steps to reproduce this issue
• I formatted all code samples correctly (if relevant)

Expected Behavior

A command like

stargazed --username almereyda --token of_sorts --sort --repository awesome-stars -w

sets up a GitHub repository, if not existing, and Action for updating the repository.

Current Behavior

1. Running the command without the repository existing does not create it with an initial commit and does not set the GitHub Action.
2. Running the command for a manually created repository does not create a commit and does not create a visible action in https://github.com/almereyda/awesome-stars/actions/new

Possible Solution

stargazed is able to fetch the repository's configuration If the repository does not yet exist, it is being created and set up with an initial commit plus GitHub Action. (Note the -w flag.)

Steps to Reproduce

1. Run the stargazed command above with your username and your personal access token.
2. Review the GitHub Actions

Context (Environment)

This is a Fedora 30, Node 10 environment.

Possible Implementation

It could be nice to have a CLI flag that can read the repository configuration and update on the status of an eventual integration.

some content hrefs are buggy

Try

stargazed -u "phanirithvij"

- [DIGITAL Command Language](#digital-command language) is the output
The expected output should be

- [DIGITAL Command Language](#digital-command-language)

Run linting test in CI

Update configuration to use CI to run lint test along with yarn run test.

Index link breaks on Languages that has symbols in it

Correction:

[C#](#c-1)
[C++](#c-2)
[Objective-C++](#objective-c-1)

If C# is missing, C++ will get #c-1 in the end trail of URL

Have to go through GitHub readme docs

Pipe chars don't get escaped (breaking markdown table)

Checklist

• I checked that this is not an existing issue
• I gave clear steps to reproduce this issue
• I formatted all code samples correctly (if relevant)

Expected Behavior

The pipe (|) gets escaped.

Current Behavior

The pipe (|) is not escaped, breaking the markdown of the table row.

Possible Solution

Escape the pipe

Steps to Reproduce

Live example (anti-xss):

Context

Original description of voku/anti-xss:

Detailed Description

Escape the pipe (|) to prevent it from breaking the markdown.

Possible Implementation

Token Permission/scopes

Need List of Scopes that are required for TOKEN to make the stargazed CLI work like charm?