hint

Markdown 格式检查工具
授权协议 MIT
开发语言 Python
所属分类 程序开发、 Markdown开发包
软件类型 开源软件
地区 国产
投 递 者 祝叶五
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

hint 是一个简单的 markdown 静态检查的控制台 cli 工具,可以方便 markdown 开发者轻松集成 travis 自动检测。

一、安装

pip install hint

然后在系统中会得到一个 hint 的命令 cli 工具。

二、使用

使用方法有两种:

2.1 一种是命令行 cli 方式,简单使用方法如下:

hint markdown_file

或者

hint markdown_folder

或者使用 hint --help 查看帮助信息和具体详细的使用方法。

$ hint --help
Usage: hint-script.py [OPTIONS] FILE

Options:
  -i, --ignore TEXT         The error codes which will be ignored.
  -f, --format [text|json]  The output format of error information.
  -m, --max-depth INTEGER   The max depth for traverse the path.
  --help                    Show this message and exit.

可以用于直接集成到各种 ci 系统中,例如 travis-ci。

2.2 另外一种是代码 API 调用的方式,简单使用方法如下:

import hint

text='''
hint 是一个简单的 **markdown** 静态检查的控制台 `cli` 工具。
可以方便 markdown 开发者轻松集成 travis 自动检测。
'''
errors = hint.check(text, ignore='E201')

fn = 'README.md'
errors = hint.check_file(fn, format='text')

可以方便的进行第三方扩展开发。

三、错误码

检查规则来源于 chinese-copywriting-guidelines,错误码命名方式参考于 flake8。目前支持的错误码如下所示:

错误码 检查类型 详细描述 完成
E101 空格 中英文之间需要增加空格 done
E102 空格 中文与数字之间需要增加空格 done
E103 空格 全角标点与其他字符之间不加空格 done
E104 空格 除了%、℃、°、以及倍数单位(如 2x、3n)之外,数字与单位之间需要增加空格 done
E201 标点 不重复使用标点符号 done
E202 标点 只有中文或中英文混排中,一律使用中文全角标点 done
E203 标点 如果出现整句英文,则在这句英文中使用英文、半角标点 done
E204 标点 省略号请使用……标准用法 done
E205 标点 英文和后面的半角标点之间不需要空格 done
E301 数字 数字使用半角字符 done

关于各种错误码的正确、错误范例,可以参考 tests/md目前有了大概的代码结构,欢迎 PR 更多的检查错误类型和检查方式

  • Oracle中的Hint可以用来调整SQL的执行计划,提高SQL执行效率。下面分类介绍Oracle数据库中常见的Hint。这里描述的是Oracle11gR2中的常见Hint,Oracle数据库中各个版本中的Hint都不尽相同,所以这里讲述的的Hint可能并不适用于Oracle早期的版本。 一、与优化器模式相关的Hint 1、ALL_ROWS ALL_ROWS是针对整个目标SQL的Hint,它的含义

  • Hint 是Oracle 提供的一种SQL语法,它允许用户在SQL语句中插入相关的语法,从而影响SQL的执行方式。 因为Hint的特殊作用,所以对于开发人员不应该在代码中使用它,Hint 更像是Oracle提供给DBA用来分析问题的工具 。在SQL代码中使用Hint,可能导致非常严重的后果,因为数据库的数据是变化的,在某一时刻使用这个执行计划是最优的,在另一个时刻,却可能很差,这也是CBO 取代R

  • 在SQL语句优化过程中,我们经常会用到hint,现总结一下在 SQL优化过程中常见Oracle HINT的用法: 1. /+ALL_ROWS/ 表明对语句块选择基于开销的优化方法,并获得最佳吞吐量,使资源消耗最小化. 例如: SELECT /+ALL+_ROWS/ EMP_NO,EMP_NAM,DAT_IN FROM BSEMPMS WHERE EMP_NO=‘SCOTT’; 2. /+FIRST

  • 作者|陈出新 SphereEx 中间件研发工程师,Apache ShardingSphere Committer,目前专注于 Apache ShardingSphere 内核模块的研发工作。 背景 Apache ShardingSphere 基于用户的实际使用场景,为用户打造了多种实用功能,包括数据分片、读写分离等。在数据分片功能中,Apache ShardingSphere 提供了标准分片、复合

  • 前言:KingbaseES V8R6C4 之前版本hint 使用方法是与Postgresql 相同的,通过 pg_hint_plan扩展,支持在SQL中使用hint。由于该版本的hint只能放置于SQL开始处,无法对子查询单独使用hint,实际使用非常不方便。由于无法对子查询单独使用hint,对于父查询与子查询使用相同表别名的情况就无法使用hint。从V8R6C4版本开始,KingbaseES 在

  • Oracle Hint Hint 是Oracle 提供的一种SQL语法,它允许用户在SQL语句中插入相关的语法,从而影响SQL的执行方式。 因为Hint的特殊作用,所以对于开发人员不应该在代码中使用它,Hint 更像是Oracle提供给DBA用来分析问题的工具 。在SQL代码中使用Hint,可能导致非常严重的后果,因为数据库的数据是变化的,在某一时刻使用这个执行计划是最优的,在另一个时刻,却可能很

  • 在SQL语句优化过程中,我们经常会用到hint,现总结一下在SQL优化过程中常见Oracle HINT的用法:   1. /*+ALL_ROWS*/   表明对语句块选择基于开销的优化方法,并获得最佳吞吐量,使资源消耗最小化.   例如:   SELECT /*+ALL+_ROWS*/ EMP_NO,EMP_NAM,DAT_IN FROM BSEMPMS WHERE EMP_NO=’SCOTT’;

  • 相对而言ORACLE优化器已经非常智能,产生的执行计划也是最优的,但是ORACLE还是提供了一些hint供用户显示的控制执行计划,因为大千世界各种各样的业务都有,ORACLE优化器生成的执行计划并不一定适用于所有业务,同时hint对于DBA而言更是一件利器,我们可以通过hint看到优化后的执行计划,总结一下常用hint。 1.全表扫描hint full(table_name) 相对而言,全表扫描h

  • Plan Hint是PG社区官方版”永远”不考虑引入的功能之一(参见PG TODO,查找”Oracle-style”),社区开发者的理念是,引入Hint功能,会掩盖优化器本身的问题,导致缺陷不被暴露出来。但对于使用者来讲,遇到某些SQL的查询计划不好,性能出了问题,其他方法又不奏效的情况下,首先的目标还是想尽快解决问题,而Hint就可以在这种时候帮助到我们。 民间的 pg_hint_plan插件

  • 介绍 基于shardingsphere-jdbc 5.1.0 进行单库分表. 规则配置 Hint 分片算法需要用户实现 org.apache.shardingsphere.sharding.api.sharding.hint.HintShardingAlgorithm 接口。 Apache ShardingSphere 在进行路由时,将会从 HintManager 中获取分片值进行路由操作。 tr

 相关资料
  • 我正在尝试编写一个应用程序,输入一美元金额打印在一张支票上,我遇到了麻烦,知道如何打印出一张支票中的数字,用前导****星号保护。 这是我到目前为止的代码

  • 问题内容: 在python中,我想检查输入字符串是否为“ HH:MM”,例如01:16或23:16或24:00。结果为真或假。 如何通过使用正则表达式来实现? 问题答案: 您可以不使用正则表达式来实现:

  • 问题内容: 如何检查给定的字符串是否采用以空格/换行符分隔的多个json字符串形式? 例如, 给定的:(3个json与空格连接) return :,因为item( 和)中的每个都是有效的json。 在Go中,我可以编写一个O(N ^ 2)函数,例如: 但这不适用于大量输入。 问题答案: 有两种选择。从编码的角度来看,最简单的方法就是正常解码JSON字符串。您可以通过解码为空结构来提高效率: (游乐

  • 检查给定的字符串是否为16进制字符串。和web3.utils.isHex()的区别在于,web3.utils.isHexStrict() 方法要求合法的16进制字符串必须具有0x前缀。 调用: web3.utils.isHexStrict(hex) 参数: hex - String|HEX: 要检查的字符串 返回值: Boolean:参数为16进制字符串则返回true,否则返回false 示例代

  • 使用新的Visual Studio代码编辑器vs 1。这不是完整的Visual Studio IDE,而是它们的atom。基于io的代码编辑器。我想安装专门用于拼写检查和格式化代码的插件。我该怎么做? 我遵循了这里的说明:Atom编辑器中是否有格式化HTML的命令?但意识到我没有安装插件命令。

  • 问题内容: 我想创建一个函数来接收输入字符串,该字符串可以是json格式的字符串,也可以只是一个字符串。例如,以下功能很简单。 问题答案: 我不清楚您是否仅需要了解“引号字符串”,还是需要了解json或两者之间的区别,因此,这向您展示了如何检测这两种情况,因此您可以非常具体。 我也在这里发布了交互式代码示例:http : //play.golang.org/p/VmT0BVBJZ7 将输出以下内容

  • 这个问题以前被问过很多次,也被回答过很多次,但是我不知道我做错了什么。从Firebase控制台向整个应用程序发送通知可以正常工作,但如果我向单个令牌发送通知,则Firebase控制台会出现错误:"Firebase注册令牌无效。检查令牌格式” 我正在Iphone设备上测试该应用程序。 已在创建新密钥https://developer.apple.com/account/ios/authkey/ 下载

  • 问题内容: 我正在尝试检查最终用户输入的日期是否在YYYY-MM-DD中。正则表达式从来都不是我的强项,对于设置的preg_match(),我总是收到错误的返回值。 所以我假设我把正则表达式弄得一团糟,下面详述。 有什么想法吗? 问题答案: 尝试这个。