lissatransborda / transchange

A CLI package to change names in github repositories files

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Transchange

Transchange é um programa criado para pessoas transgênero desenvolvedoras que precisam ter o trabalho de mudar as referências aos seus nomes em seus repositórios no Github, mas teriam muito trabalho para fazer isso manualmente, e também seria um processo doloroso ter que ficar lendo e corrigindo seu nome morto.

Por isso, criei esse utilitário de linha de comando para fazer essa alteração de maneira automática em todos os repositórios de alguém, tornando este processo pelo menos um pouco menos amargo.

Requisitos

Para utilizar o Transchange, é necessário ter o git de linha de comando instalado.

Instalação

Para instalar o Transchange de maneira simples, use o comando abaixo:

npm install -g transchange

Caso dê um erro relacionado á permissão, adicione um sudo antes, como no comando abaixo:

sudo npm install -g transchange

Uso

Execute o transchange através do seguinte comando no terminal:

transchange

Caso dê um erro relacionado á permissão, adicione um sudo antes, como no comando abaixo:

sudo transchange

Para utilizar o transchange, é necessário passar cinco parâmetros no terminal interativo:

  1. Seu usuário no Github;
  2. Seu nome morto no Git;
  3. Texto antigo (como um nome morto);
  4. Texto novo (como seu nome);
  5. Email morto;
  6. Seu Email;
  7. Arquivos que devem ser mudados - separados por vírgula (README.md, LICENSE, etc.)
    • Valor default é README.md, package.json.
    • Se pode utilizar wildcards para alterar grupos de arquivos, como por exemplo:
      • *.md -> Todos os arquivos com extensão .md
      • .config. -> Todos os arquivos que tenham .config. no nome
  8. Fazer a busca em todos os subdiretorios do repositorio (Responder com 'Y' para sim ou 'N' para não);
  9. O nome do commit que será feita essa alteração (Recomendo esconder essa mudança com um commit chamado update README)
    • Valor default é update README.md.

Print do terminal interativo da aplicação transchange com todas as perguntas

Esse comando pode ser repetido várias vezes mudando o arquivo que você deseja editar.

Contribuições

O projeto aceita de braços abertos contribuições que possam ser feitas, tanto no código quanto fora dele, mas principalmente, divulgue o projeto para que mais pessoas trans tenham acesso, e menos dor em pelo menos um único aspecto de um processo tão amargo quanto fel. ❤️

About

A CLI package to change names in github repositories files

License:GNU Affero General Public License v3.0


Languages

Language:JavaScript 100.0%