From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rainer M Krug Subject: Re: [RFC] Org linting library Date: Wed, 20 May 2015 17:08:21 +0200 Message-ID: References: <87a8y4fdmv.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha1; protocol="application/pgp-signature" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:41683) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Yv5bg-0004ff-BV for emacs-orgmode@gnu.org; Wed, 20 May 2015 11:08:29 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Yv5bd-00064j-5A for emacs-orgmode@gnu.org; Wed, 20 May 2015 11:08:28 -0400 Received: from mail-wi0-f170.google.com ([209.85.212.170]:38818) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Yv5bc-00064X-Sv for emacs-orgmode@gnu.org; Wed, 20 May 2015 11:08:25 -0400 Received: by wichy4 with SMTP id hy4so63672950wic.1 for ; Wed, 20 May 2015 08:08:24 -0700 (PDT) In-Reply-To: (Rainer M. Krug's message of "Wed, 20 May 2015 17:01:58 +0200") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Andreas Leha Cc: emacs-orgmode@gnu.org --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Rainer M Krug writes: > Andreas Leha writes: > >> Hi Rainer, >> >> Rainer M Krug writes: >>> Nicolas Goaziou writes: >>> >>>> Hello, >>>> >>>> The following library implements linting for Org syntax. The sole publ= ic >>>> function is `org-lint', which see. >>>> >>>> Internally, the library defines a new structure: `org-lint-checker', >>>> with the following slots: >>>> >>>> - NAME: Unique check identifier, as a symbol. The check is done >>>> calling the function `org-lint-NAME' with one mandatory argument, >>>> the parse tree describing the current Org buffer. Such function >>>> calls are wrapped within a `save-excursion' and point is always at >>>> `point-min'. Its return value has to be an alist (POSITION MESSAGE) >>>> when POSITION refer to the buffer position of the error, as an >>>> integer, and MESSAGE is a strings describing the error. >>>> >>>> - DESCRIPTION: Summary about the check, as a string. >>>> >>>> - CATEGORIES: Categories relative to the check, as a list of symbol. >>>> They are used for filtering when calling `org-lint'. Checkers not >>>> explicitly associated to a category are collected in the `default' >>>> one. >>>> >>>> - TRUST: The trust level one can have in the check. It is either `lo= w' >>>> or `high', depending on the heuristics implemented and the nature = of >>>> the check. This has an indicative value only and is displayed along >>>> reports. >>>> >>>> All checks have to be listed in `org-lint--checkers'. >>>> >>>> Results are displayed in a special "*Org Lint*" buffer with a dedicated >>>> major mode, derived from `tabulated-list-mode'. In addition to the usu= al >>>> key-bindings inherited from it, "C-j" displays problematic line report= ed >>>> under point and "RET" jumps to it. >>>> >>>> Checks currently implemented are: >>>> >>>> - duplicates CUSTOM_ID properties >>>> - duplicate NAME values >>>> - duplicate targets >>>> - duplicate footnote definitions >>>> - orphaned affiliated keywords >>>> - obsolete affiliated keywords >>>> - missing language in src blocks >>>> - NAME values with a colon >>>> - wrong header arguments in src blocks >>>> - misuse of CATEGORY keyword >>>> - "coderef" links with unknown destination >>>> - "custom-id" links with unknown destination >>>> - "fuzzy" links with unknown destination >>>> - "id" links with unknown destination >>>> - links to non-existent local files >>>> - special properties in properties drawer >>>> - obsolete syntax for PROPERTIES drawers >>>> - missing definition for footnote references >>>> - missing reference for footnote definitions >>>> - non-footnote definitions in footnote section >>>> - probable invalid keywords >>>> - invalid blocks >>>> - probable incomplete drawers >>>> - obsolete QUOTE section >>>> >>>> Since it relies on lexical binding, `pcase' and `string-prefix-p', it >>>> cannot be added to Org 8.3, but can make it into Org 8.4, if deemed >>>> useful enough. >>>> >>> >>> This sounds very interesting and I would like to try it out. I >>> understand that it can't be put into master, but could it be put into a >>> branch? >>> >>> This would make testing a bit easier. >>> >> >> It is. The branch is called `wip-lint'. > > Thanks (also to Nicolas) - I found it. Just expected the branch to be > tracked automatically. > > This is really brilliant! > > But I now get a message in one .org file: > > ,---- > | Org linting process starting... > | Search failed: "^[ ]*#\\+NAME: +tab:sensVar" > `---- > > and no results. > > Works in other .org files. > > This one is rather long (11570 lines) and many code blocks. > > Just let me know how I can trace down where this is coming from and what > the message tells me. It seems that the error comes from the fact that ~#+LABEL: sensVar~ was defined twice. Renaming these results in working linting. Rainer > > Thanks, > > Rainer > >> >> Regards, >> Andreas >> >> =2D-=20 Rainer M. Krug, PhD (Conservation Ecology, SUN), MSc (Conservation Biology,= UCT), Dipl. Phys. (Germany) Centre of Excellence for Invasion Biology Stellenbosch University South Africa Tel : +33 - (0)9 53 10 27 44 Cell: +33 - (0)6 85 62 59 98 Fax : +33 - (0)9 58 10 27 44 Fax (D): +49 - (0)3 21 21 25 22 44 email: Rainer@krugs.de Skype: RMkrug PGP: 0x0F52F982 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG/MacGPG2 v2.0.22 (Darwin) iQEcBAEBAgAGBQJVXKNlAAoJENvXNx4PUvmCDTwIAKuTiZ1Rfb4KV9zybiHsBdAc Jnw2JqT6CyxW1EjsIHmSf2PSNuy6YTxbhIGU6Jh5b/lOfeqTX4B+RR2bYGcTD1Ja N5w6xY8/XVlrYX99iY0S23p4luO7R5KvqDd3eNboL5kuPms/a3QojCHOpal94YRC T/pqGKvJdSL6Jlx/gwMF2Dwjh869fFGLtouRXUya8IT8F2kA90DwdWk5hmulLuHz HbP+uBkRRtpjvdOu7tW2Cn0EqAOvAbe6cc4qaNSg6Pfj+vRWtB0tA8DnghYCtSCG 2U5XxfzREJHe9oONImKfs4RTZ+wUoq0H/DVd6D9TKgVfOEbugB9M58sOffJYbYM= =q1bE -----END PGP SIGNATURE----- --=-=-=--