seo analyzer
1.0.0
HTMLファイルを分析するライブラリは、すべてのSEO欠陥を表示します。
CLIを使用するには、パッケージをグローバルにインストールする必要があります。
npm install -g seo-analyzerseo-analyzer -h| オプション | args | 説明 |
|---|---|---|
| -H、 - ヘルプ | ヌル | すべてのオプションを表示します。 |
| -v、-version | ヌル | 表示アプリケーションバージョン：アプリケーションの現在のバージョンを表示します。 |
| -iu、-ignoreurls | [配列] | 分析から特定のURLを除外します。不要なWebページの処理を避けるために、分析から特定のURLを除外します。 |
| -if、-ignorefiles | [配列] | 分析から特定のファイルを除外します。分析から特定のファイルを除外し、処理を防ぎます。 |
| -ifl、-ignorefolders | [配列] | 分析から特定のフォルダーを除外します。これらのフォルダー内のすべてのファイルを無視して、分析プロセスから指定されたフォルダーを除外します。 |
| -u、-urls | [配列] | 指定されたURLでSEO分析を実行します。特定のSEO基準に準拠を確認し、指定されたURLのSEO分析を実施します。 |
| -f、 - ファイル | [配列] | 指定されたファイルでSEO分析を実行する：指定されたファイルでSEO分析を実行し、最適化標準とルールに順守することを保証します。 |
| -fl、 - フォルダー | [配列] | 指定されたフォルダーでSEO分析を実行します。SEOルールと推奨事項に準拠するために、指定されたフォルダー内のすべてのファイルを分析します。 |
| -r、 - ルール | [配列] | 分析に特定のSEOルールを適用します。分析中に特定のSEOルールを適用し、ユーザーが検査プロセスをカスタマイズできるようにします。デフォルトでは、すべてのデフォルトルールを実行します。 |
seo-analyzer -u https://maddevs.io https://maddevs.io/blogseo-analyzer -u https://maddevs.io -r titleLengthRule= ' { "min": "500" } 'JSON形式を使用して、パラメーターをルールに渡します。
SEOアナライザーをGitHubでのアクションとして使用するには、次のコンテンツを使用して.github/workflows/aremy.ymlでワークフローファイルを作成できます。
name : SEO analyzer
on : [push]
jobs :
seo-analyzer :
runs-on : ubuntu-latest
steps :
- uses : actions/checkout@v4
- name : Use Node.js
uses : actions/setup-node@v4
with :
node-version : ' 20.x '
- run : npm i -g seo-analyzer
- run : seo-analyzer -u https://maddevs.io最後のステップでは、分析するURLを指定できます。
プロジェクトにインストールします。
npm install -D seo-analyzerSEOアナライザーのセットアップは、できるだけシンプルです。それは次のようになります：
const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. inputFiles ( < array > )
.addRule( < function > )
.addRule( < function > )
.outputConsole()
.run();次に、いくつかの例を紹介します。
const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. inputUrls ( [ 'https://maddevs.io' , 'https://maddevs.io/blog' ] )
. addRule ( 'imgTagWithAltAttributeRule' )
. outputConsole ( )
. run ( ) ; const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. ignoreUrls ( [ '/404' , '/login' ] )
. inputSpaFolder ( '/dist' , 'sitemapindex.xml' , 3000 )
. addRule ( 'imgTagWithAltAttributeRule' )
. outputConsole ( )
. run ( ) ; const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. inputFiles ( [ 'index.html' , 'about.html' ] )
. addRule ( 'imgTagWithAltAttributeRule' )
. outputConsole ( ) ; const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. inputFolders ( [ 'dist' , 'src' ] )
. addRule ( 'imgTagWithAltAttributeRule' )
. outputConsole ( )
. run ( ) ; const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. inputFolders ( [ 'dist' , 'src' ] )
. addRule ( 'imgTagWithAltAttributeRule' )
. outputJson ( json => console . log ( json ) )
. run ( ) ; const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. ignoreFolders ( [ 'src/test' ] )
. ignoreFiles ( [ 'src/404.html' ] )
. inputFolders ( [ 'dist' , 'src' ] )
. addRule ( 'imgTagWithAltAttributeRule' )
. outputObject ( obj => console . log ( obj ) )
. run ( ) ; const SeoAnalyzer = require ( 'seo-analyzer' ) ;
new SeoAnalyzer ( )
. inputHTMLString (
'<!DOCTYPE html><html><body><h1>title</h1><p>content</p></body></html>'
)
. addRule ( 'imgTagWithAltAttributeRule' )
. outputConsole ( )
. run ( ) ; | 方法 | パラメージ | 説明 |
|---|---|---|
| IngoreFiles | ['dist/about.html'] | この方法では、分析前にファイルの配列が無視することが予想されます。 |
| 無視してください | ['Dist/Ingrore'] | この方法では、分析前に一連のフォルダーが無視することが予想されます。 |
| Ingroreurls | ['/404'] | この方法では、分析前にURLの配列が無視することが予想されます。 |
| 入力ファイル | ['dist/index.html'] | この方法では、HTMLファイルの配列が期待されます。 |
| inputurls | ['https://maddevs.io'] | この方法は、分析するURLの配列を期待しています。 |
| 入力フォルダー | ['dist'、 'src'] | この方法では、HTMLファイルを備えたフォルダーの配列が期待されます。 |
| inputspafolder | '/dist'、 'sitemap.xml'、3000 | この方法では、Run Server用の生産＆ポートにSPAビルドファイルを備えた一連のフォルダーが期待されます。 |
| InputhtmlString | ['例'] | この方法では、HTMLを含む文字列が予想されます。 |
| addrule | 関数（dom）{} | このメソッドは、着信HTMLファイルを確認するカスタムルールを追加します。 |
| outputObject | function（obj）{} | この方法は、JavaScriptオブジェクトとしてレポートを返します。 |
| outputjson | function（json）{} | このメソッドは、JSON形式でレポートを返します。 |
| outputConsole | ヌル | この方法は、コンソールのプロセスを完了するため、チェーンの最後で使用する必要があります。 |
以下は、SEOアナライザーに転送された各ファイルに対して実行されるルールです。それらはデフォルトで無効にされており、追加する必要があります。
タグ<title>の長さをチェックします。 2つのパラメーターが受け入れられます。
. addRule ( 'titleLengthRule' , { min : 10 , max : 50 } )すべての<img>タグがalt = ""属性があるかどうかを確認します。
. addRule ( 'imgTagWithAltAttributeRule' )<a> rel属性ルールを備えたタグすべての<a>タグにrel = ""属性があるかどうかを確認します。
. addRule ( 'aTagWithRelAttributeRule' )指定された基本メタタグがページに存在するかどうかを確認します。 1つのパラメーターを受け入れます。
. addRule ( 'metaBaseRule' , { list : [ 'description' , 'viewport' ] } )指定されたソーシャルメタタグがページに存在するかどうかを確認します。 1つのパラメーターを受け入れます。
. addRule ( 'metaSocialRule' , {
properties : [
'og:url' ,
'og:type' ,
'og:site_name' ,
'og:title' ,
'og:description' ,
'og:image' ,
'og:image:width' ,
'og:image:height' ,
'twitter:card' ,
'twitter:text:title' ,
'twitter:description' ,
'twitter:image:src' ,
'twitter:url'
] ,
} )ページに正規のリンクが存在するかどうかを確認します。
. addRule ( 'canonicalLinkRule' )カスタムルールは、DOMツリー引数を取得する関数です。
function customRule ( dom ) {
return new Promise ( async ( resolve , reject ) => {
const paragraph = dom . window . document . querySelector ( 'p' ) ;
if ( paragraph ) {
resolve ( '' ) ;
} else {
reject ( 'Not found <p> tags' ) ;
}
} ) ;
}
. . .
. addRule ( customRule )
. . . MITライセンス
著作権（c）2024 Mad Devs
このソフトウェアと関連するドキュメントファイル（「ソフトウェア」）のコピーを入手して、制限なしにソフトウェアを扱うために、このソフトウェアを制限する権利を含め、ソフトウェアのコピーをコピー、変更、公開、配布、販売する、ソフトウェアのコピーを許可する人を許可する人を許可することを含めて、許可が無料で許可されます。
上記の著作権通知とこの許可通知は、ソフトウェアのすべてのコピーまたはかなりの部分に含まれるものとします。
このソフトウェアは、商品性、特定の目的への適合性、および非侵害の保証を含むがこれらに限定されない、明示的または黙示的なものを保証することなく、「現状のまま」提供されます。いかなる場合でも、著者または著作権所有者は、契約、不法行為、またはその他の訴訟、ソフトウェアまたはソフトウェアの使用またはその他の取引に関連する、またはその他の契約、またはその他の請求、またはその他の責任について責任を負いません。
