diff --git a/api/index.js b/api/index.js index a17387c..b1b0b3a 100644 --- a/api/index.js +++ b/api/index.js @@ -5,9 +5,9 @@ const { parseArray, clampValue, CONSTANTS, -} = require("../src/utils"); -const fetchStats = require("../src/fetchStats"); -const renderStatsCard = require("../src/renderStatsCard"); +} = require("../src/common/utils"); +const fetchStats = require("../src/fetchers/stats-fetcher"); +const renderStatsCard = require("../src/cards/stats-card"); module.exports = async (req, res) => { const { @@ -18,6 +18,7 @@ module.exports = async (req, res) => { hide_rank, show_icons, count_private, + include_all_commits, line_height, title_color, icon_color, @@ -31,7 +32,11 @@ module.exports = async (req, res) => { res.setHeader("Content-Type", "image/svg+xml"); try { - stats = await fetchStats(username, parseBoolean(count_private)); + stats = await fetchStats( + username, + parseBoolean(count_private), + parseBoolean(include_all_commits) + ); } catch (err) { return res.send( renderError( @@ -56,6 +61,7 @@ module.exports = async (req, res) => { hide_title: parseBoolean(hide_title), hide_border: parseBoolean(hide_border), hide_rank: parseBoolean(hide_rank), + include_all_commits: parseBoolean(include_all_commits), line_height, title_color, icon_color, diff --git a/api/pin.js b/api/pin.js index b017204..22eb851 100644 --- a/api/pin.js +++ b/api/pin.js @@ -5,9 +5,9 @@ const { clampValue, CONSTANTS, logger, -} = require("../src/utils"); -const fetchRepo = require("../src/fetchRepo"); -const renderRepoCard = require("../src/renderRepoCard"); +} = require("../src/common/utils"); +const fetchRepo = require("../src/fetchers/repo-fetcher"); +const renderRepoCard = require("../src/cards/repo-card"); module.exports = async (req, res) => { const { diff --git a/api/top-langs.js b/api/top-langs.js index a758e33..552dd1e 100644 --- a/api/top-langs.js +++ b/api/top-langs.js @@ -5,9 +5,9 @@ const { parseBoolean, parseArray, CONSTANTS, -} = require("../src/utils"); -const fetchTopLanguages = require("../src/fetchTopLanguages"); -const renderTopLanguages = require("../src/renderTopLanguages"); +} = require("../src/common/utils"); +const fetchTopLanguages = require("../src/fetchers/top-languages-fetcher"); +const renderTopLanguages = require("../src/cards/top-languages-card"); module.exports = async (req, res) => { const { diff --git a/package.json b/package.json index 0adc010..d167c1b 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,7 @@ "dependencies": { "dotenv": "^8.2.0", "emoji-name-map": "^1.2.8", + "github-username-regex": "^1.0.0", "word-wrap": "^1.2.3" }, "husky": { diff --git a/readme.md b/readme.md index 62377fe..ccea98b 100644 --- a/readme.md +++ b/readme.md @@ -41,6 +41,8 @@ Deutsch · 日本語 + · + Português Brasileiro
Loved the project? Please consider donating to help it improve!
@@ -135,8 +137,9 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
- `hide_title` - _(boolean)_
- `hide_rank` - _(boolean)_
- `show_icons` - _(boolean)_
+- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_
- `count_private` - Count private commits _(boolean)_
-- `line_height` - Sets the line-height betweent text _(number)_
+- `line_height` - Sets the line-height between text _(number)_
#### Repo Card Exclusive Options:
@@ -235,6 +238,10 @@ You can use the `&layout=compact` option to change the card design.

+- Include All Commits
+
+
+
- Themes
Choose from any of the [default themes](#themes)
@@ -277,7 +284,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
Guide on setting up Vercel
+ Guide on setting up Vercel 🔨
1. Go to [vercel.com](https://vercel.com/)
1. Click on `Log in`
diff --git a/readme_es.md b/readme_es.md
index 28a338b..738e0b6 100644
--- a/readme_es.md
+++ b/readme_es.md
@@ -44,7 +44,7 @@
# Características
- [Tarjeta de estadísticas de GitHub](#tarjeta-de-estadísticas-de-github)
-- [Pins extra de GitHub](#pins-extra-de-github)
+- [Pins adicionales de GitHub](#pines-adicionales-de-github)
- [Temas](#temas)
- [Personalización](#personalización)
- [Despliega por tu cuenta](#despliega-tu-propia-instancia-de-vercel)
@@ -107,69 +107,59 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr
-Puedes ver una vista previa de [todos los temas disponibles](./themes/README.md) o ver el [archivo de configuración](./themes/index.js) del tema y también **puedes contribuir con nuevos temas** si lo deseas: D
+Puedes ver una vista previa de [todos los temas disponibles](./themes/README.md) o ver el [archivo de configuración](./themes/index.js) del tema y también **puedes contribuir con nuevos temas** si lo deseas :D
### Personalización
Puedes personalizar el aspecto de tu `Stats Card` o `Repo Card` de la manera que desees con los parámetros URL.
-Opciones de personalización:
+#### Opciones Comunes:
-| Option | type | description | Stats Card (default) | Repo Card (default) |
-| ----------- | --------- | ----------------------------- | -------------------- | ------------------- |
-| title_color | hex color | color del título | 2f80ed | 2f80ed |
-| text_color | hex color | color del contenido | 333 | 333 |
-| icon_color | hex color | color del ícono | 4c71f2 | 586069 |
-| bg_color | hex color | color de fondo | FFFEFE | FFFEFE |
-| line_height | number | controla el line_height | 30 | N/A |
-| hide_rank | boolean | oculta la clasificación | false | N/A |
-| hide_title | boolean | oculta el título | false | N/A |
-| hide_border | boolean | oculta el borde | false | N/A |
-| show_owner | boolean | muestra el propietario | N/A | false |
-| show_icons | boolean | muestra los íconos | false | N/A |
-| theme | string | establece un tema incorporado | 'default' | 'default_repocard' |
+- `title_color` - Color del título _(hex color)_
+- `text_color` - Color del contenido _(hex color)_
+- `icon_color` - Color de icono si esta disponible _(hex color)_
+- `bg_color` - Color de fondo _(hex color)_
+- `theme` - Nombre del tema, elige uno de [todos los temas disponible ](./themes/README.md)
+- `cache_seconds` - Cache _(min: 1800, max: 86400)_
+
+> Nota sobre la caché: las tarjetas de Repo tienen un caché predeterminado de 30 minutos (1800 segundos) si el recuento forks y el recuento de estrellas es inferior a 1k; de lo contrario, son 2 horas (7200). También tenga en cuenta que el caché está sujeto a un mínimo de 30 minutos y un máximo de 24 horas
+
+#### Opciones exclusivas de la tarjeta de estadísticas:
+
+- `hide` - Ocultar los elementos especificados de las estadísticas _ (valores separados por comas) _
+- `hide_title` - _(boolean)_
+- `hide_rank` - _(boolean)_
+- `show_icons` - _(boolean)_
+- `include_all_commits` - Cuente los commits totales en lugar de solo los commits del año actual _(boolean)_
+- `count_private` - Cuenta los commits privadas _(boolean)_
+- `line_height` - Establece el alto de línea entre texto _(number)_
+
+#### Opciones exclusivas de la tarjeta Repo:
+
+- `show_owner` - Mostrar el nombre del propietario del repositorio _(boolean)_
+
+#### Opciones exclusivas de la tarjeta de lenguajes:
+
+- `hide` - Ocultar los lenguajes especificados de la tarjeta _(valores separados por comas)_
+- `hide_title` - _(boolean)_
+- `layout` - Cambiar entre dos diseños disponibles `default` & `compact`
+- `card_width` - Establecer el ancho de la tarjeta manualmente _(number)_
+
+> :warning: **Importante:**
+> Los nombres de los idiomas deben tener escape de uri, como se especifica en [Código porciento](https://es.wikipedia.org/wiki/C%C3%B3digo_porciento)
+> (es decir: `c++` debería convertirse en `c%2B%2B`,`jupyter notebook` debería convertirse en `jupyter%20notebook`, etc.)
---
-### Ejemplo
+# Pines adicionales de GitHub
-- Predeterminado
+Los pines adicionales de GitHub le permiten fijar más de 6 repositorios en su perfil utilizando un readme de perfil de GitHub.
-
-
-- Ocultando estadísticas específicas
-
-
-
-- Mostrando íconos
-
-
-
-- Temas
-
-Elige uno de los [temas predeterminados](#temas)
-
-
-
-- Personalizando la tarjeta de estadísticas
-
-
-
-- Personalizando la tarjeta de repositorio
-
-
-
----
-
-# Pins extra de GitHub
-
-Los pins extra de GitHub te permiten anclar más de 6 repositorios en tu perfil utilizando el archivo README.md.
-
-¡Bien! Ya no estás limitado a 6 repositorios anclados.
+Yey! Ya no está limitado a 6 repositorios anclados.
### Utilización
-Copia y pega este código en tu README.md y cambia los links.
+Copie y pegue este código en su archivo Léame y cambie los enlaces.
Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
@@ -185,9 +175,89 @@ Utiliza la variable [show_owner](#customización) para incluir el nombre de usua
[](https://github.com/anuraghazra/github-readme-stats)
-### Pequeño consejo (alinear las tarjetas de repositorios)
+# Tarjeta de lenguajes principales
-Usualmente no serías capaz de alinear las imágenes una al lado de otra. Para lograrlo, puedes realizar esto:
+La tarjeta de lenguajes principales muestra los lenguajes principales del usuario de github que se han utilizado principalmente.
+
+_NOTA: los lenguajes principales no indican mi nivel de habilidad o algo así, es una métrica de github de los lenguajes que tengo más código en github, es una nueva característica de github-readme-stats_
+
+### Utilización
+
+Copie y pegue este código en su readme y cambie los enlaces.
+
+Endpoint: `api/top-langs?username=anuraghazra`
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Ocultar lenguajes individuales
+
+Puede usar el parámetro `? Hide = language1, language2` para ocultar lenguajes individuales.
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Diseño de tarjeta de lenguaje compacta
+
+Puede usar la opción `& layout = compact` para cambiar el diseño de la tarjeta.
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Ejemplo
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+- Diseño compacto
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+---
+
+### Todos los ejemplos
+
+- Por Defecto
+
+
+
+- Ocultar estadísticas específicas
+
+
+
+- Mostrando iconos
+
+
+
+- Incluir todos los Commits
+
+
+
+- Temas
+
+Elija entre cualquiera de los [temas predeterminados](#themes)
+
+
+
+- Personalizando tarjeta de estadísticas
+
+
+
+- Personalizar la tarjeta de repositorio
+
+
+
+- Lenguajes Principales
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+---
+
+### Consejo rápido (alinee las tarjetas de repositorio)
+
+Por lo general, no podrá diseñar las imágenes una al lado de la otra. Para hacerlo, puede usar este enfoque:
```md
@@ -222,7 +292,7 @@ Nota: debido a esto [#58](https://github.com/anuraghazra/github-readme-stats/pul
1. Selecciona `Import Git Repository`

1. Selecciona "root" y matén todo como está, simplemente añade tu variable de entorno llamada PAT_1 (como se muestra), la cual contendrá un token de acceso personal (PAT), el cual puedes crear fácilmente [aquí](https://github.com/settings/tokens/new) (mantén todo como está, simplemente asígnale un nombre, puede ser cualquiera que desees)
- 
+ 
1. Clickea "Deploy" y ya está listo. ¡Ve tus dominios para usar la API!
+
+
Adicione suas estatísticas no GitHub geradas dinamicamente em seus readmes!
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ver demonstração + · + Reportar erros + · + Solicitar recursos +
++ 简体中文 + · + Español + · + Deutsch + · + 日本語 + · + Português Brasileiro +
+ +Gostou do projeto? Por favor considere fazer uma doação para ajudar a melhorá-lo!
+
+# Características
+
+- [Cartão de estatísticas do GitHub](#cartão-de-estatísticas-do-github)
+- [Pins extras do GitHub](#pins-extras-do-github)
+- [Cartão de principais linguagens de programação](#cartão-de-principais-linguagens-de-programação)
+- [Temas](#temas)
+- [Personalização](#personalização)
+- [Faça suas próprias implantações](#faça-suas-próprias-implantações)
+
+# Cartão de estatísticas do GitHub
+
+Copie e cole isso no seu conteúdo de remarcação e é isso. Simples!
+
+Mude o valor de `?username=` para o seu nome de usuário no GitHub.
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+_Nota: As classificações são baseadas nas estatísticas do usuário, veja [src/calculateRank.js](./src/calculateRank.js)_
+
+### Ocultando estatísticas específicas
+
+Para ocultar estatísticas individualmente, você pode passar um parâmetro de consulta `?hide=` com valores separados por vírgula.
+
+> Opções: `&hide=stars,commits,prs,issues,contribs`
+
+```md
+
+```
+
+### Adicionando contagem de contribuições privadas à contagem total de commits
+
+Adicione a contagem de todas as suas contribuições privadas à contagem total de confirmações usando o parâmetro de consulta `?count_private=true`.
+
+_Nota: Se você estiver implantando este projeto, as contribuições privadas serão contadas por padrão; caso contrário, você precisará compartilhar suas contagens de contribuições privadas._
+
+> Opções: `&count_private=true`
+
+```md
+
+```
+
+### Exibindo ícones
+
+Para habilitar ícones, basta utilizar o parâmetro `show_icons=true` na sua requisição, da seguinte forma:
+
+```md
+
+```
+
+### Temas
+
+Com temas predefinidos, pode personalizar a aparência dos cartões sem precisar fazer nenhuma [configuração manual](#personalização).
+
+Utilize o parâmetro `?theme=THEME_NAME`, da seguinte forma:
+
+```md
+
+```
+
+#### Todos os temas predefinidos :
+
+dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
+
+
+
+Visualize [todos o temas disponíveis](./themes/README.md) ou o [arquivo de configuração de tema](./themes/index.js), além de **também poder contribuir com novos temas**, se desejar :D
+
+### Personalização
+
+Personalize a aparência do seu `Stats Card` ou `Repo Card` da maneira que desejar com os parâmetros de URL.
+
+#### Opções comuns
+
+- `title_color` - Cor do título do cartão _(hex color)_
+- `text_color` - Cor de texto do conteúdo _(hex color)_
+- `icon_color` - Cor dos ícones (se disponível) _(hex color)_
+- `bg_color` - Cor de fundo do cartão _(hex color)_
+- `theme` - Nome do tema, escolha em [todos os temas disponíveis](./themes/README.md)
+- `cache_seconds` - Defina o cabeçalho do cache manualmente _(min: 1800, max: 86400)_
+
+> Nota sobre o cache: Cartões de repositório tem um cache padrão de 30 minutos (1800 segundos), se o número a contagem de forks e contagem de estrelas é menor que 1 mil o padrão é 2 horas (7200). Note também que o cache é limitado a um mínimo de 30 minutos e um máximo de 24 horas.
+
+#### Opções exclusivas do cartão de estatísticas:
+
+- `hide` - Oculta itens específicos das estatísticas _(Valores separados por vírgulas)_
+- `hide_title` - Ocutar o título _(boolean)_
+- `hide_rank` - Ocultar a classificação _(boolean)_
+- `show_icons` - Mostrar ícones _(boolean)_
+- `include_all_commits` - Contabiliza todos os commits ao invés de apenas os atual ano _(boolean)_
+- `count_private` - Contabiliza commits privados _(boolean)_
+- `line_height` - Define a altura do espaçamento entre o texto _(number)_
+
+#### Opções exclusivas do cartão de repositórios:
+
+- `show_owner` - Exibir o nome da pessoa a quem o repositório pertence _(boolean)_
+
+#### Opções exclusivas do cartão de linguagens:
+
+- `hide` - Oculta linguagens específicas _(Valores separados por vírgulas)_
+- `hide_title` - Oculta o título _(boolean)_
+- `layout` - Alterna entre os dois layouts disponíveis `default` & `compact`
+- `card_width` - Define a largura do cartão manualmente _(number)_
+
+> :warning: **Importante:**
+> Nomes de linguagens devem ser uma sequência escapada de URI, como específicado em [Codificação por cento](https://pt.wikipedia.org/wiki/Codificação_por_cento)
+> (Isso é: `c++` deve se tornar `c%2B%2B`, `jupyter notebook` deve se tornar `jupyter%20notebook`, etc.)
+
+---
+
+# Pins extras do GitHub
+
+Os Pins extras do GitHub permitem fixar mais de 6 repositórios no seu perfil usando um perfil README.me do GitHub.
+
+Uhu! Você não está mais limitado a 6 repositórios fixados.
+
+### Utilização
+
+Copie e cole esse código no seu README.md e altere os atributos.
+
+Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Demonstração
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+Utilize a variável [show_owner](#personalização) para incluir o nome de usuário do proprietária do repositório
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+# Cartão de principais linguagens de programação
+
+Exibe uma métrica de linguagens de programação mais usadas pelo usuário do GitHub.
+
+_Nota: As principais linguagens de programação não fazem declarações sobre habilidades pessoais ou similares, é apenas uma figura-chave com base nas estatísticas do GitHub do usuário indicando a frequência com que cada uma foi utilizada._
+
+### Utilização
+
+Copie e cole esse código no seu README.md e altere os atributos.
+
+Endpoint: `api/top-langs?username=anuraghazra`
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Ocultar linguagens individualmente
+
+Utilize o parâmetro `?hide=language1,language2` para ocultar linguagens específicas.
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Layout de cartão de linguagens compacto
+
+Utilize a opção `&layout=compact` para mudar o layout do cartão.
+
+```md
+[](https://github.com/anuraghazra/github-readme-stats)
+```
+
+### Demonstração
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+- Layout compacto
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+---
+
+### Todas as demonstrações
+
+- Padronizado
+
+
+
+- Ocultando estatísticas específicas
+
+
+
+- Mostrando ícones
+
+
+
+- Incluir todos os commits
+
+
+
+- Temas
+
+Escolha entre um dos [temas predefinidos](#temas)
+
+
+
+- Personalizando o cartão de estatísticas
+
+
+
+- Customizando o cartão de repositório
+
+
+
+- Principais linguagens
+
+[](https://github.com/anuraghazra/github-readme-stats)
+
+---
+
+### Dica (Alinhandos os cartões de repositório)
+
+Por padrão, você não poderá organizar as imagens lado a lado. Para fazer isso, você pode usar a seguinte abordagem:
+
+```md
+
+
+
+
+
+
+```
+
+## Implante em sua própria instância do Vercel
+
+Como a API do GitHub permite apenas 5 mil solicitações por hora, é possível que minha `https://github-readme-stats.vercel.app/api` atinja a cota limite. Se hospedar em seu próprio servidor Vercel, não precisará se preocupar com nada. Clique no botão de implantação para começar!
+
+Nota: Desde [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) há possibilidade de lidar com mais de 5 mil chamadas por hora, sem interrupções :D
+
+[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
+
+
Guia de configuração do Vercel
+
+1. Acesse [vercel.com](https://vercel.com/)
+1. Clique em `Login`
+ 
+1. Acesse com o GitHub clicando em `Continue with GitHub`
+ 
+1. Entre no GitHub e permita acesso a todos os repositórios, se solicitado
+1. Faça Fork neste repositório
+1. Volte ao seu [painel principal do Vercel](https://vercel.com/dashboard)
+1. Selecione `Import Project`
+ 
+1. Selecione `Import Git Repository`
+ 
+1. Selecione a raiz e mantenha tudo como está, basta adicionar sua variável de ambiente chamada PAT_1 (que será exibida), que conterá um token de acesso pessoal (PAT), que você pode criar facilmente [aqui](https://github.com/settings/tokens/new) (deixe tudo como está, apenas dê um nome, que pode ser o que você quiser)
+ 
+1. Clique em `deploy` e já estará tudo pronto. Veja seus domínios para usar a API!
+
+