Разработка и Git

Проверить README проекта

Ищет README, проверяет непустой файл, заголовок и наличие разделов установки, использования и лицензии.

Batch Windows Новичок
Скачать readme-check.bat
Описание

Что делает скрипт

Скрипт проверяет README.md, README.rst, README.txt и README в корне проекта. Затем ищет ключевые слова install, usage, license и contribut без учёта регистра. Это быстрая проверка перед публикацией, файлы не изменяются.

Запуск

Быстрый старт

readme-check.bat .

Скачайте файл, откройте терминал в папке со скриптом и выполните команду. Запускайте из cmd.exe.

Примеры

Другие варианты

  • readme-check.bat
  • readme-check.bat D:\Projects\app
Зависимости

Что понадобится

Windows 10/11 cmd.exe входит в Windows
Windows Встроено в Windows 10/11
Исходник

readme-check.bat

@echo off
setlocal EnableExtensions EnableDelayedExpansion

set "ROOT=%~1"
if "%ROOT%"=="" set "ROOT=."
if not exist "%ROOT%\" (
    echo Folder not found: %ROOT%
    exit /b 1
)

pushd "%ROOT%" || exit /b 1
set "README="
for %%f in (README.md README.rst README.txt README) do (
    if not defined README if exist "%%f" set "README=%%f"
)

if not defined README (
    echo No README file found.
    popd
    exit /b 1
)

for %%f in ("%README%") do if %%~zf==0 (
    echo README is empty: %README%
    popd
    exit /b 1
)

echo Found: %README%
set "MISSING="

findstr /r /c:"^# " "%README%" >nul
if errorlevel 1 (
    echo Warning: no top-level Markdown heading.
)

findstr /i /c:"install" "%README%" >nul
if errorlevel 1 (
    echo Missing section or word: install
    set "MISSING=1"
)

findstr /i /c:"usage" "%README%" >nul
if errorlevel 1 (
    echo Missing section or word: usage
    set "MISSING=1"
)

findstr /i /c:"license" "%README%" >nul
if errorlevel 1 (
    echo Missing section or word: license
    set "MISSING=1"
)

findstr /i /c:"contribut" "%README%" >nul
if errorlevel 1 (
    echo Missing section or word: contributing
    set "MISSING=1"
)

if defined MISSING (
    echo README needs review.
    popd
    exit /b 1
)

echo README basic checks passed.
popd
exit /b 0

Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get dev-readme-check
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Разработка и Git

Git, сборка, тесты, зависимости, логи и обслуживание проектов.